README

用于连接 Microsites API 的软件开发套件

安装

您应该添加 PlacetoPay 存储库

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://dev.placetopay.com/repository"
        }
    ]
}

然后，您可以通过 composer 安装此包

composer require placetopay/microsites-sdk

使用方法

首先要做的是创建一个 Gateway 类的实例，并将凭据（登录，apiKey，url）作为数组传递给参数。示例

return new Gateway([
    'login' => 'user_placetopay',
    'apiKey' => 'P2P123#',
    'url' => 'https://dev.placetopay.com',
]);

可用方法

createMicrosite()

要创建一个微站，必须从 Gateway 类的实例调用 createMicrosite() 方法，并将 MicrositeTransaction 类的实例作为参数传递，该实例接收一个包含请求字段的数组。示例

$data = new MicrositeTransaction([
    'name' => 'exampleName',
    'alias' => 'exampleAlias,
    'type' => OptionsFields::OPEN_TYPE,
    'sites' => [1, 2, 3, 4, 10],
    'allowPartial' => true,
    'categories' => ['test_tecnologia'],
    'loginFields' => 1,
    'version' => OptionsFields::VERSION_2,
    'paymentExpiration' => 10,
]);

$response = $gateway->createMicrosite($data);

响应

在每个可用方法中获得的响应始终属于一个 'Status' 类型的实体，这是包含 Placetopay 'Base' 包的项目所理解的。它包括：状态、原因、消息和日期。

{
  +status: "OK"
  +reason: "00"
  +message: "{"status":{"status":"OK","reason":201,"message":"Microsite created successfully",
            "date":"2022-11-24T17:03:15-05:00"},
            "data":{"id":706,"url":"https:\/\/dev.placetopay.com\/microsites\/c120964463a1efc84e8c"}}"
  +date: "2022-11-24T16:25:39+00:00"
}

仅获取状态

$response->status

仅获取原因

$response->reason

仅获取消息

$response->message

仅获取日期

$response->date

要从消息中获取某些特定数据，您必须解码消息属性的 JSON 并访问所需的数据属性。

示例

json_decode($response->message)->data->url   //To get the url of a created microsite

常量

optionsFile 类包含以下常量

public const OPEN_TYPE = 'OPEN';
public const CLOSED_TYPE = 'CLOSED';

public const VERSION_1 = 'v1';
public const VERSION_2 = 'v2';

建议在给 "type" 和 "version" 字段赋值时使用它们。

重要

• 创建公开微站和封闭微站之间最大的区别是，封闭微站需要一个支付订单参考，而公开微站则不需要。重要的是要强调，您必须在请求的 "type" 字段中指明您想创建哪种类型的微站。

• 请记住，必须将 MicrositeTransaction 的实例作为参数传递给可用方法，以避免异常或错误。

• 注意，"name" 和 "alias" 字段是特定于给定站点关联的微站的，使用相同的名称或别名创建微站将返回失败状态。

更多关于微站 API 的信息，请参阅文档 此处