README

Secursus 是最强大的包裹数字保险，覆盖最敏感的物品，每个包裹最高可达 100,000 欧元。为了将保险服务集成到您的网站上，我们提供这个 PHP 库，允许您自动化您的保险订单。

有关产品的更多信息，请访问我们的网站：https://www.secursus.com/integration/

先决条件

要使用 Secursus API，您需要在我们的平台上创建一个账户并激活它。

https://www.secursus.com/integration/registration.php

安装

composer require secursus/api

使用

use Secursus\Api;

// Set your API credentials here
$secursus = new Api(
    "YOUR_API_ID", 
    "YOUR_API_KEY"
);

// And call methods after
$action = $secursus->retrieveParcelOrder("YOUR_PARCEL_ID");

文档

获取保险金额费用

此方法用于计算保险费用。

更多详细信息：https://developer.secursus.com/parcels/fees

使用

$insuranceAmount = $secursus->getInsuranceAmount(10000);

参数

创建包裹订单方法只能接收一个参数，即包裹价值。此参数必须是 整数，表示包裹的总价值（欧元分）。

创建包裹订单

创建了一个包裹对象并返回了保险凭证。一旦对象被创建，如果您想要取消保险订单，您有 12 个小时的时间。

更多详细信息：https://developer.secursus.com/parcels/create

使用

$parcelOrder = $secursus->createParcelOrder($data);

数据参数

创建包裹订单方法可以接收一个包含以下八个参数的 数组（其中六个是必需的）

条目	必需	数据类型	描述
`parcel_value`	是	整数	订单总价值（欧元分）。
`first_name`	是	字符串	客户名。
`last_name`	是	字符串	客户姓。
`email`	是	字符串	客户电子邮件地址。
`full_address`	是	字符串	客户完整地址。
`cart_data`	是	Json	您网站上购物车的详细信息。不需要特定格式，此信息将用于任何索赔分析。
`company`	否	字符串	客户公司名称。
`lang`	否	字符串	用于向客户发送保险确认电子邮件的语言。可能的值有两个：“fr”或“en”。默认值：“en”。

检索包裹订单

此方法用于获取保险凭证和包裹信息。

使用

$parcelOrder = $secursus->retrieveParcelOrder($idParcelOrder);

参数

检索包裹订单方法只能接收一个参数，即包裹 ID。此参数必须是 字符串，是 createParcelOrder 方法生成的保险 ID。

检索当前包裹报告

此方法用于获取本月中所有应到期的包裹列表。

使用

$parcelOrder = $secursus->retrieveCurrentReport();

检索历史包裹报告

此方法用于获取账户的所有包裹列表。

使用

$parcelOrder = $secursus->retrieveHistoryReport();

取消包裹订单

此方法用于取消您之前发送的保险订单。

注意：一旦保险请求被创建，如果您想要取消保险订单，您有 12 个小时的时间。在此期间之后，保险订单被视为确认，无法取消。之后，保险费用将需支付。

更多详细信息：https://developer.secursus.com/parcels/cancel

使用

$parcelOrder = $secursus->cancelParcelOrder($idParcelOrder);

参数