awardspring/awardspring-php

Official AwardSpring API client for PHP.

0.1.8 2026-08-11 20:57 UTC

Requires

• php: ^8.1
• ext-json: *
• php-http/discovery: ^1.0
• php-http/multipart-stream-builder: ^1.0
• psr/http-client: ^1.0
• psr/http-client-implementation: ^1.0
• psr/http-factory: ^1.0
• psr/http-factory-implementation: ^1.0
• psr/http-message: ^1.1 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: 3.5.0
• guzzlehttp/guzzle: ^7.4
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^12.5.22

MIT

• AwardSpring

• api
• sdk
• awardspring

Published on Packagist.org on 2026-08-11 20:57 UTC

README

The Awardspring PHP library provides convenient access to the Awardspring APIs from PHP.

Table of Contents

• Documentation
• Requirements
• Installation
• Usage
• Environments
• Exception Handling
• Advanced
  • Custom Client
  • Retries
  • Timeouts
• Contributing

Documentation

API reference documentation is available here.

Requirements

This SDK requires PHP ^8.1.

Installation

composer require awardspring/awardspring-php

Usage

Instantiate and use the client with the following:

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Donors\Requests\ListDonorsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donors->list(
    new ListDonorsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donors->get(
    1,
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\DonorActivities\Requests\ListDonorActivitiesRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donorActivities->list(
    1,
    new ListDonorActivitiesRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\DonorActivities\Requests\GetDonorActivitiesRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donorActivities->get(
    1,
    1,
    new GetDonorActivitiesRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Gifts\Requests\ListGiftsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->gifts->list(
    new ListGiftsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Scholarships\Requests\ListScholarshipsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->scholarships->list(
    new ListScholarshipsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Scholarships\Requests\ListAvailableDollarsScholarshipsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->scholarships->listAvailableDollars(
    new ListAvailableDollarsScholarshipsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Scholarships\Requests\GetAvailableDollarsScholarshipsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->scholarships->getAvailableDollars(
    1,
    new GetAvailableDollarsScholarshipsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Scholarships\Requests\ListAwardedStudentsScholarshipsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->scholarships->listAwardedStudents(
    new ListAwardedStudentsScholarshipsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Funds\Requests\ListFundsRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->funds->list(
    new ListFundsRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\AwardCycles\Requests\ListAwardCyclesRequest;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->awardCycles->list(
    new ListAwardCyclesRequest([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->awardCycles->getCurrent();

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Donors\Requests\CreateDonorV1Request;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donors->create(
    new CreateDonorV1Request([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Donors\Requests\UpdateDonorV1Request;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donors->update(
    1,
    new UpdateDonorV1Request([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Donors\Requests\UpdateDonorNotesV1Request;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donors->updateNotes(
    1,
    new UpdateDonorNotesV1Request([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\DonorActivities\Requests\CreateDonorActivityV1Request;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->donorActivities->create(
    1,
    new CreateDonorActivityV1Request([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Gifts\Requests\CreateGiftV1Request;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->gifts->create(
    new CreateGiftV1Request([]),
);

<?php

namespace Example;

use Awardspring\AwardspringApiClient;
use Awardspring\Scholarships\Requests\CreateScholarshipV1Request;

$client = new AwardspringApiClient(
    apiKey: '<value>',
);
$client->scholarships->create(
    new CreateScholarshipV1Request([
        'awardCycleId' => 1,
    ]),
);

Environments

This SDK allows you to configure different environments for API requests.

The SDK defaults to the `UnitedStates` environment. To use a different environment, pass it to the client constructor:

```php
use Awardspring\AwardspringApiClient;
use Awardspring\Environments;

$client = new AwardspringApiClient(
    token: '<YOUR_TOKEN>',
    options: [
        'baseUrl' => Environments::Staging->value
    ]
);

Available environments:

• Environments::UnitedStates
• Environments::Canada

## Exception Handling

When the API returns a non-success status code (4xx or 5xx response), an exception will be thrown.

```php
use Awardspring\Exceptions\AwardspringApiException;
use Awardspring\Exceptions\AwardspringException;

try {
    $response = $client->donors->list(...);
} catch (AwardspringApiException $e) {
    echo 'API Exception occurred: ' . $e->getMessage() . "\n";
    echo 'Status Code: ' . $e->getCode() . "\n";
    echo 'Response Body: ' . $e->getBody() . "\n";
    // Optionally, rethrow the exception or handle accordingly.
}

Advanced

Custom Client

This SDK is built to work with any HTTP client that implements the PSR-18 ClientInterface. By default, if no client is provided, the SDK will use php-http/discovery to find an installed HTTP client. However, you can pass your own client that adheres to ClientInterface:

use Awardspring\AwardspringApiClient;

// Pass any PSR-18 compatible HTTP client implementation.
// For example, using Guzzle:
$customClient = new \GuzzleHttp\Client([
    'timeout' => 5.0,
]);

$client = new AwardspringApiClient(options: [
    'client' => $customClient
]);

// Or using Symfony HttpClient:
// $customClient = (new \Symfony\Component\HttpClient\Psr18Client())
//     ->withOptions(['timeout' => 5.0]);
//
// $client = new AwardspringApiClient(options: [
//     'client' => $customClient
// ]);

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Error)

The retryStatusCodes configuration controls which 5XX status codes are retried:

• legacy (default): Retries 408, 429, and all >= 500
• recommended: Retries 408, 429, 502, 503, 504 only (excludes 500 Internal Server Error to avoid retrying non-idempotent failures)

Use the maxRetries request option to configure this behavior.

$response = $client->donors->list(
    ...,
    options: [
        'maxRetries' => 0 // Override maxRetries at the request level
    ]
);

Timeouts

The SDK defaults to a 30 second timeout. Use the timeout option to configure this behavior.

$response = $client->donors->list(
    ...,
    options: [
        'timeout' => 3.0 // Override timeout at the request level
    ]
);

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!