webthatmatters/apparatus-php-sdk

This package is abandoned and no longer maintained. No replacement package was suggested.

Utility classes for communicating with the Apparatus API.

Maintainers

Details

gitlab.com/webthatmatters/apparatus/apparatus-php-sdk

Homepage

Installs: 3 690

Dependents: 0

Suggesters: 0

Security: 0

2.2.2 2019-08-27 15:11 UTC

Requires

MIT f53e28831ec5f2ea4b6055ec3c84ac0c2a994a4d

sdkapparatus

This package is auto-updated.

Last update: 2022-11-11 15:35:56 UTC

README

A collection of classes to ease apparatus integration development with PHP applications.

Usage

  • Install using composer require webthatmatters/apparatus-php-sdk
  • Instantiate a new ApparatusService with a configured Configuration object like so:
use WebThatMatters\Apparatus\ApparatusService;
use WebThatMatters\Apparatus\Configuration;

$config = new Configuration();
$config->setKey("your_apparatus_secret")
       ->setIntegrationId("your_apparatus_integration_id")
       ->setIssuer("your_application_name")
       ->setVersion("preferred_api_version")
       ->setEmailUrl("url_to_use_in_magic_links");
       
$service = new ApparatusService($config);
  • Use the created service object to perform operations on the Apparatus API

Supported Operations

In this version of the SDK, the following operations are implemented:

  • createToken($claims = []): Create a JWT signed with your apparatus secret.
  • getTokenPayload($token) : Retrieve the claims of a JWT signed with your secret as an associative array
  • sendMagicLink($email, $params = []) : Send a magic link email to the address specified. Note that no address validation is performed here. You may also pass any query string parameters as a second argument.
  • createUser($userData) : Create a user in apparatus. Valid data keys are email,phone and name