README

此软件包帮助您进行客户身份验证。它提供了一个简单而强大的接口，通过方法连接来语义构建您的请求。

用户验证变得像写几行代码一样简单

后端

\Doinc\PersonaKyc\Persona::init()->accounts()->create("my-account-reference-id");

前端

const client = new Persona.Client({
    templateId: "itmpl_Ygs16MKTkA6obnF8C3Rb17dm",
    environment: "sandbox",
    referenceId: "my-account-reference-id",
    onReady: () => client.open(),
    onComplete: ({inquiryId, status, fields}) => console.log("onComplete"),
    onCancel: ({inquiryId, sessionToken}) => console.log('onCancel'),
    onError: (error) => console.log("onError"),
});

安装

您可以通过composer安装此包

composer require do-inc/laravel-persona-kyc
php artisan persona:install

运行安装命令将自动发布配置文件、迁移并编译所有存根。

您可以通过运行以下命令手动发布所有资产：

php artisan vendor:publish --tag="persona-kyc-migrations"
php artisan migrate

您可以使用以下命令发布配置文件：

php artisan vendor:publish --tag="persona-kyc-config"

此外，还应该定义几个环境变量

PERSONA_API_KEY="persona_sandbox_XXX"
PERSONA_WEBHOOK_SECRET="wbhsec_XXX"

使用方法

基本

Persona 提供了无需创建自定义流程或处理冗长和复杂的验证流程即可轻松验证用户身份的可能性。

验证过程从创建账户开始，账户必须带有引用ID以将多个查询链接在一起。为了减少复杂性并轻松查询远程数据，请考虑将您的 用户ID 作为 引用ID。

$account = \Doinc\PersonaKyc\Persona::init()->accounts()->create("1234");

提供了许多不同的内置方法，这些方法将简化使用Persona作为验证提供者的简单和定制解决方案的开发。

请参阅此方法列表以获取所有可用方法的完整列表。

Webhooks

Persona自带支持webhooks。为了强制执行安全的webhooks使用，防止任何篡改，提供了一个默认端点 /persona/hook，此外还可以通过配置选项添加前缀。

webhook将根据接收到的请求发出事件，每个事件都会收到预解析的模型，这将避免错误。

这意味着访问Persona webhooks就像设置一个监听器来监听您感兴趣的事件一样简单！

请参阅此事件列表以获取所有可用事件的完整列表。

测试

将 .env.example 文件复制到 .env，填写所有变量，然后运行

composer test

变更日志

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

贡献

有关详细信息，请参阅贡献指南

安全漏洞

如果您发现任何与安全相关的问题，请通过电子邮件security@do-inc.co联系，而不是使用问题跟踪器。

致谢

• Emanuele (ebalo) Balsamo
• 所有贡献者

许可证

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