ownage/approvedeny-sdk-php

1.0.0 2023-07-15 14:18 UTC

README

Latest Version on Packagist Total Downloads GitHub Actions

ApproveDeny SDK for PHP 提供了一种简单的方法,使用 PHP 与 ApproveDeny API 进行交互。

安装

需要 PHP 8.1+

您可以通过 composer 安装此包

composer require ownage/approvedeny-sdk-php

用法

要使用 SDK,您需要创建一个 approvedeny 的 Client 类实例。您可以通过将 API 密钥传递给构造函数来完成此操作。

use Ownage\ApproveDeny\Client;

$client = new Client('your-api-key');

创建新的检查请求

要创建新的检查请求,您需要在客户端实例上调用 createCheckRequest 方法。

$checkRequest = $client->createCheckRequest('check-id', [
    'description' => 'A description of the check request',  
    'metadata' => [
        'key' => 'value',
    ],
]);

检索检查请求

要检索检查请求,您需要在客户端实例上调用 getCheckRequest 方法。

$checkRequest = $client->getCheckRequest('check-request-id');

检索检查请求响应

要检索检查请求响应,您需要在客户端实例上调用 getCheckRequestResponse 方法。

$checkRequestResponse = $client->getCheckRequestResponse('check-request-id');

验证 webhook 签名

要验证 webhook 签名,您需要在客户端实例上调用 isValidWebhookSignature 方法。此方法返回一个布尔值,指示签名是否有效。

$isValidSignature = $client->isValidWebhookSignature('your-encryption-key', 'signature', ['foo' => 'bar']);

if ($isValidSignature) {
    // The signature is valid
} else
    // The signature is invalid
}

测试

composer test

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关详细信息,请参阅 CONTRIBUTING

安全

如果您发现任何安全相关的问题,请使用问题跟踪器。

致谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件