README

连接 Acrosure 保险网关的 PHP SDK

安装

通过 Composer 安装

composer require acrosure/acrosure-php-sdk

入门指南

将 AcrosureClient 导入您的项目。

require_once dirname(__FILE__).'/vendor/autoload.php';

使用来自 Acrosure 控制台的 API 密钥进行实例化。

$acrosureClient = new AcrosureClient([
  "token" => "<your_api_key>",
  "endpointBase" => "<endpoint_base>" // as optional
]);

基本用法

AcrosureClient 提供了诸如 application、product 等对象及其相关 API。

任何数据都将包含在具有 data 键的响应对象中，以及元数据，例如

{
  "data": { ... },
  "status": "ok",
  ...
}

应用

获取

获取指定 ID 的应用。

$application = $acrosureClient->getApplicationManager()->get("<application_id>");

创建

创建一个应用。

$createdApplication = $acrosureClient->getApplicationManager()->create([
  "product_id" => "<product_id>", // required
  "basic_data" => json_decode('{}'),
  "package_options" => json_decode('{}'),
  "additional_data" => json_decode('{}'),
  "package_code" => "<package_code>",
  "attachments": => []
]);

更新

更新一个应用。

$updatedApplication = $acrosureClient->getApplicationManager()->update([
  "application_id" => "<application_id>", // required
  "basic_data": json_decode('{}'),
  "package_options": json_decode('{}'),
  "additional_data": json_decode('{}'),
  "package_code": "<package_code>",
  "attachments": []
]);

获取包

获取当前应用可用的包。

$packages = $acrosureClient->getApplicationManager()->getPackages("<application_id>");

选择包

为当前应用选择包。

$updatedApplication = $acrosureClient->getApplicationManager()->selectPackage([
  "application_id" => "<application_id>",
  "package_code" => "<package_code>"
]);

获取包

获取当前应用的所选包。

$currentPackage = $acrosureClient->getApplicationManager()->getPackage(
  "<application_id>"
);

提交

提交当前应用。

$submittedApplication = $acrosureClient->getApplicationManager()->submit(
  "<application_id>"
);

确认

确认当前应用。

$confirmedApplication = $acrosureClient->getApplicationManager()->confirm(
  "<application_id>"
);

列表

列出您的应用（带有或不带查询）。

$applications = $acrosureClient->getApplicationManager()->getList(searchParams);

产品

获取

获取指定 ID 的产品。

$product = $acrosureClient->getProductManager()->get("<product_id>");

列表

列出您的产品（带有或不带查询）。

$products = $acrosureClient->getProductManager()->getList(searchParams);

保险单

获取

获取指定 ID 的保险单。

$policy = $acrosureClient->getPolicyManager()->get("<policy_id>");

列表

列出您的保险单（带有或不带查询）。

$policies = $acrosureClient->getPolicyManager()->getList(searchParams);

数据

获取

获取处理器的值（是否包含依赖项，请参阅 Acrosure API 文档）。

// Without dependencies
$values = $acrosureClient->getDataManager()->get([
  "handler" => "<some_handler>"
]);

// With dependencies
$values = $acrosureClient->getDataManager()->get([
  "handler" => "<some_handler>",
  "dependencies" => ["<dependency_1>", "<dependency_2>"]
]);

团队

获取信息

获取当前团队信息。

$teamInfo = $acrosureClient->getTeamManager()->getInfo();

其他功能

验证 webhook 签名

通过指定签名和原始数据字符串验证 webhook 签名。（仅 Node.js 环境）

$isSignatureValid = $acrosureClient->verifySignature(
  "<signature>",
  "<raw_data>"
);

acrosure / acrosure-php-sdk

维护者

详细信息