Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

Blackbaud SKY API

Security covered Maintenance fixes only 136 sites

This module connects to the Blackbaud SKY API using OAuth. It provides a class to make API calls, supporting GET, POST, PATCH, and DELETE requests. The module also includes functionality to track API quota limits and notify when they are reached.

This module is for connecting via OAuth to the Blackbaud SKY API. That is all this does, but it gives you a method and a class to work with to call the API to get results.

Drupal 8

No requirements needed to use this module. Works out of the box.

Drupal 7

This module require Composer Manager & Xautoload (version >5.0).

After you install these module and configure Composer Manager, then run this in the composer directory:

composer require guzzlehttp/guzzle

How to Use

Once you setup and authorize the module here: /admin/config/services/blackbaud

In your files do this:

use Drupal\blackbaud_sky_api\BlackbaudAPI;

function whatever() {
  $bb = new BlackbaudAPI();

  // This will return an object on success or NULL if it fails
  // Endpoints defined here: https://developer.sky.blackbaud.com/docs/services/
  $api = $bb->callAPI('endpoint');
}

All API calls default to GET. If you wanted to POST, PATCH or DELETE, do this instead:

use Drupal\blackbaud_sky_api\BlackbaudAPI;

function whatever() {
  $bb = new BlackbaudAPI();

  // This will return an object on success or NULL if it fails
  // Endpoints defined here: https://developer.sky.blackbaud.com/docs/services/
  $api = $bb->callAPI('endpoint', 'POST');
}

Extending the Class

You can do this if you need to add more magic, etc

namespace Drupal\YOURMODULE;

use Drupal\blackbaud_sky_api\BlackbaudAPI;

YOURCLASS extends BlackbaudAPI {
 // codez
}

D7 Variable

I added a variable called blackbaud_sky_api_quota_reached to basically handle 403 based responses for daily quote limit reached (typically 25,000 on free accounts). This is useful in a batch situation when you need to exit early. It also sends a watchdog message telling when you can hit the API again.

Drupal 8–10 · not 11

Ask your assistant about Blackbaud SKY API

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
1
Tracked since
Aug 2023
Latest release
3 years ago
Releases (12 mo)
0
Maintenance
Dormant

Releases

Version Type Core PHP Release date
8.x-1.2 Stable 8–10 Aug 3, 2023