nateritter/atrium-php

MX Atrium API的PHP包装器。

v0.1.2 2018-12-01 22:43 UTC

This package is auto-updated.

Last update: 2024-09-29 04:26:02 UTC


README

MX Atrium API的PHP包装器。为了发送请求,您需要注册MX Atrium API并获取MX-API-KEYMX-CLIENT-ID

安装

使用Composer或Yarn将库添加到您的应用程序中

composer install nateritter/atrium-php

yarn add nateritter/atrium-php

用法

在源代码中使用以下方式使用atrium模块:

use NateRitter\AtriumPHP\AtriumClient;

然后使用以下配置您的实例。(ENVIRONMENT将根据开发环境为vestibule.mx.com,或根据生产环境为atrium.mx.com。)

$atriumClient = new AtriumClient('ENVIRONMENT', 'YOUR_MX_API_KEY', 'YOUR_MX_CLIENT_ID');

然后,开始使用类方法调用Atrium API进行数据操作。有关详细信息,请参阅完整的Atrium文档

# use AtriumClient wrapper class
use NateRitter\AtriumPHP\AtriumClient;

# Configure AtriumClient
$atriumClient = new AtriumClient('ENVIRONMENT', 'YOUR_MX_API_KEY', 'YOUR_MX_CLIENT_ID');

# Now begin making Atrium calls
$atriumClient->createUser(['identifier' => 'UniqueID']); # Create a user, etc...

示例

/examples目录中包含各种工作流程和代码片段。在运行之前,您需要首先修改每个示例中显示的以下行,包括环境、YOUR-MX-API-KEY和YOUR-MX-CLIENT-ID。

$atriumClient = new AtriumClient('ENVIRONMENT', 'YOUR_MX_API_KEY', 'YOUR_MX_CLIENT_ID');