README

使用方法

需要SDK composer包

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

获取一个实例进行请求

use Web3IsGoingJustGreat\CredentialsDev\SDK\Credentials;

$apiToken = 'thisIsSuperSecret';

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

可用方法

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

人员

$sdkInstance->listPeople(); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\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

订阅

use \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\SubscribePerson;

$sdkInstance->subscribeToPersonEvents(string $personId, SubscribePerson $subscribePerson); // \Web3IsGoingJustGreat\CredentialsDev\SDK\Resources\PersonSubscription

文档

$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

免责声明

此SDK不是sandbox credentials.dev API的官方SDK。

关于Credentials.dev服务的公开讨论在这里进行：https://github.com/LilithWittmann/credentials_dev_public/discussions。

如有此SDK的问题或功能请求，请使用GitHub Issues：https://github.com/AndreSchwarzer/credentials-dot-dev-php-sdk/issues。

许可证

此PHP SDK是开源软件，许可协议为MIT许可。