blackbaud/onsdk

连接到 on api 的 PHP sdk

1.0.8 2019-08-23 13:28 UTC

This package is auto-updated.

Last update: 2024-09-24 00:40:34 UTC


README

Build Status

特性

  • 为所有支持的 ON API 方法和身份验证协议提供易于使用的 HTTP 客户端。
  • 目前基于 Curl 构建
  • 提供身份验证和简单的令牌管理

入门

  1. 拥有 Web 服务 API 用户 – 在开始之前,您需要注册 onSDK 并创建一个 Manager 账户。
  2. 最低要求 – 要运行 SDK,您的系统需要满足 [最低要求][docs-requirements],包括拥有编译了 cURL 扩展的 PHP >= 5.6 以及使用 TLS 后端(例如,NSS 或 OpenSSL)编译的 cURL 7.16.2+。
  3. 安装 SDK – 使用 Composer 是安装 PHP Blackbaud onSDK 的推荐方式。SDK 通过 Packagistblackbaud/onsdk 包中可用。

快速示例

通过 API 进行身份验证

<?php
// Require the Composer autoloader.
require 'vendor/autoload.php';

use Blackbaud\onSDK\onApiClient;

// Instantiate a Blackbaud Client.
$bb = new onApiClient('SchoolUrl','Username','Password');

获取用户信息

<?php
// get info about the current user account using the SDK.
try {
    $user = $bb->get_current_user();
    print_r($user);
} catch (Exception $e) {
    echo "There was an error getting user info.\n";
}