README

这是一个用于与 Signalise API 交互的 PHP 客户端。它可以执行以下操作

端点

• /api/v1/connects - 从 Signalise (商店) 获取连接 ID。
• /api/v1/connects/{{connectId}}/history - 将订单处理到 Signalise。
• /api/v1/connects/{{connectId}}/history/status - 获取已处理的最后一个订单的信息。

要求

• PHP >= 7.4
• Composer

安装

通过 composer 安装。

composer require signalise/php-client

入门

获取连接

get connects 端点用于检索所有连接 ID (商店)。

为了将订单处理到 Signalise，您需要使用连接 ID 来告知 Signalise 您想要处理订单的商店。

    /**
     * @throws ResponseException|GuzzleException
     */
    public function getConnects(
        string $apiUrl,
        string $apiKey
    ): array

发布订单历史记录

post Order history 端点用于处理订单到 Signalise。

它将抛出一个异常或一个包含成功处理 x 条记录的消息的数组。

   /**
    * @throws ResponseException|GuzzleException
    */
    public function postOrderHistory(
        string $apiUrl,
        string $apiKey,
        string $serializedData,
        string $connectId
    ): array

为了成功发布订单到 Signalise，您需要使用以下格式。

{
    "records": [
        {
            "id": 16,
            "total_products": 25,
            "total_costs": 124.6500,
            "valuta": "EUR",
            "tax": 1.15,
            "payment_method": "mollie_methods_ideal",
            "payment_costs": 0.05,
            "shipping_method": "Flat Rate - Fixed",
            "shipping_costs": 5.0000,
            "zip": "1000AA",
            "street": "Dam",
            "house_number": "1",
            "city": "Amsterdam",
            "country": "NL",
            "status": "complete",
            "date": "2021-02-11 18:24:45",
            "tag": ""
        },
        {
            "id": 17,
            "total_products": 1,
            "total_costs": 46.5000,
            "payment_method": "mollie_methods_creditcard",
            "payment_costs": 0.25,
            "shipping_method": "dhl",
            "shipping_costs": 2.5000,
            "valuta": "EUR",
            "tax": 1.15,
            "zip": "BE1000",
            "street": "Brussels Park",
            "house_number": "1",
            "city": "Brussel",
            "country": "BE",
            "status": "processing",
            "date": "2021-02-18 10:31:50",
            "tag": ""
        }
    ]
}

获取历史状态

get history status 端点将检索最后一个处理项目的信息。

    /**
     * @throws ResponseException|GuzzleException
     */
    public function getHistoryStatus(
        string $apiUrl,
        string $apiKey,
        string $connectId
    ): array

支持

Signalise PHP 客户端由 Ndottens 创建。

如果您发现错误或想提交改进，请不要犹豫，在 Gitlab 上创建合并请求。