README

一组类，用于简化 PHP 应用程序与 apparatus 集成的开发。

用法

• 使用 composer require webthatmatters/apparatus-php-sdk 安装
• 使用配置好的 Configuration 对象实例化一个新的 ApparatusService 对象，如下所示

use WebThatMatters\Apparatus\ApparatusService;
use WebThatMatters\Apparatus\Configuration;

$config = new Configuration();
$config->setKey("your_apparatus_secret")
       ->setIntegrationId("your_apparatus_integration_id")
       ->setIssuer("your_application_name")
       ->setVersion("preferred_api_version")
       ->setEmailUrl("url_to_use_in_magic_links");
       
$service = new ApparatusService($config);

• 使用创建的服务对象对 Apparatus API 执行操作

支持的操作

在此版本的 SDK 中，实现了以下操作

• createToken($claims = [])：使用您的 apparatus 密钥创建一个已签名的 JWT。
• getTokenPayload($token)：以关联数组的形式检索使用您的密钥签名的 JWT 的声明
• sendMagicLink($email, $params = [])：向指定的地址发送魔法链接电子邮件。请注意，此处不执行地址验证。您还可以将任何查询字符串参数作为第二个参数传递。
• createUser($userData)：在 apparatus 中创建用户。有效的数据键是 email、phone 和 name