Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 2.83 KB

README.md

File metadata and controls

72 lines (47 loc) · 2.83 KB
Raw

Credentials.dev API - PHP SDK

Usage

Require the SDK composer package

composer require web3-is-going-just-great/credentials-dot-dev-php-sdk

Get an instance to make requests

use Web3IsGoingJustGreat\CredentialsDev\SDK\Credentials;

$apiToken = 'thisIsSuperSecret';

// !!! Currently only sandbox mode is supported !!!
$sdkInstance = new Credentials(accessToken: $apiToken, useSandbox: true);

Available methods

$sdkInstance->default(); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\APIStatus

People

$sdkInstance->listPeople(); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\Person[]
Person
use \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\CreatePerson;

$sdkInstance->createPerson(CreatePerson $createPerson); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\Person
$sdkInstance->getPerson(string $personId); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\Person
$sdkInstance->deletePerson(string $personId); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\EmptyResult or trows \Web3IsGoingJustGreat\CredentialsDev\SDK\Exceptions\NotFoundException
Subscription
use \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\SubscribePerson;

$sdkInstance->subscribeToPersonEvents(string $personId, SubscribePerson $subscribePerson); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\PersonSubscription
Documents
$sdkInstance->listPersonDocuments(string $personId); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\Document[]
$sdkInstance->createPersonDocument(string $personId, string $externalIdentifier, string $documentBinary); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\DocumentValidationResponse
$sdkInstance->validatePersonDocument(string $personId, string $documentId); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\DocumentValidationResponse
$sdkInstance->deletePersonDocument(string $personId, string $documentId); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\EmptyResult
$sdkInstance->statsForPersonDocument(string $personId, string $documentId); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\DocumentStatistics

Disclaimer

This SDK is NOT an official SDK of the sandbox credentials.dev API.

Public discussions regarding the Credentials.dev service it self is held here: https://github.com/LilithWittmann/credentials_dev_public/discussions.

In case of problems or feature requests for this SDK, GitHub Issues can be used: https://github.com/AndreSchwarzer/credentials-dot-dev-php-sdk/issues.

License

This PHP SDK is open-sourced software licensed under the MIT license.