Repository of the Blackbaud onApi SDK for PHP
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src remove signin route Oct 15, 2018
tests Add travis ci for testing Mar 8, 2017
.gitignore First Add of updated sdk code Mar 7, 2017
.travis.yml no message Mar 8, 2017
README.md update php version Mar 8, 2017
composer.json no message Mar 8, 2017
composer.lock no message Mar 8, 2017
phpunit.xml

README.md

Build Status

Features

  • Provides easy-to-use HTTP clients for all supported ON API methods and authentication protocols.
  • Currently built on Curl
  • Provides authentication and simple token management

Getting Started

  1. Have a Web Service API user – Before you begin, you need to sign up for the onSDK and have a Manager account created.
  2. Minimum requirements – To run the SDK, your system will need to meet the [minimum requirements][docs-requirements], including having PHP >= 5.6 compiled with the cURL extension and cURL 7.16.2+ compiled with a TLS backend (e.g., NSS or OpenSSL).
  3. Install the SDK – Using Composer is the recommended way to install the Blackbaud onSDK for PHP. The SDK is available via Packagist under the blackbaud/onsdk package.

Quick Examples

Authenticate with API

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

use Blackbaud\onSDK\onApiClient;

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

Get User Info

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