README

yousign-api-php-client

Yousign REST API 客户端。

当然非常欢迎 Pull Request 以及改进建议！

结构

src/
tests/

安装

通过 Composer

$ composer require timothecrespy/yousign-api-php-client

用法

注意

测试和生产显然需要互联网连接。

框架无关

use TimotheCrespy\YousignClient;

// It is recommended to store these values in a .env or equivalent file
const YOUSIGN_PRODUCTION_API_URL = 'https://api.yousign.com';
const YOUR_PRODUCTION_API_KEY = '[YOUR_PRODUCTION_API_KEY]';

$yousignClient = new YousignClient([
    'api_url' => self::YOUSIGN_PRODUCTION_API_URL,
    'api_key' => self::YOUR_PRODUCTION_API_KEY
]);

由于 Yousign 生产 API 不是免费的，您可能想使用预发布环境进行测试

use TimotheCrespy\YousignClient;

// It is recommended to store these values in a .env or equivalent file
const YOUSIGN_STAGING_API_URL = 'https://staging-api.yousign.com';
const YOUR_STAGING_API_KEY = '[YOUR_STAGING_API_KEY]';

$yousignClient = new YousignClient([
    'api_url' => self::YOUSIGN_STAGING_API_URL,
    'api_key' => self::YOUR_STAGING_API_KEY
]);

Laravel

要求：最低版本 6.*

// If you are using Laravel (https://github.com/laravel/laravel), you could specify the default Laravel logger:
$loggerInstance = Illuminate\Support\Facades\Log::getLogger();
$yousignClient->setLogger($loggerInstance);

$yousignClient->getUsers();

变更日志

有关最近更改的更多信息，请参阅 变更日志

测试

本包基于 Yousign 的 预发布 环境与 生产 环境严格相似的假设。因此，基于此 预发布 环境进行测试。因此，API 未进行模拟，因为此 预发布 环境是免费的，并且没有任何限制。

PR 测试的进行方式如下

$ composer test

或

$ ./vendor/bin/phpcs
$ ./vendor/bin/phpunit

贡献

请参阅 贡献指南 和 行为准则 了解详情。

安全性

如果您发现任何安全相关的问题，请通过 contact@timothecrespy.fr 发送电子邮件，而不是使用问题跟踪器。

致谢

• Timothé Crespy
• 所有贡献者

特别感谢

• Julien Cauvin

许可证

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