README

用于与 Commerce Signals 平台交互的库。

使用 Composer 安装

composer require commercesignals/csapi-php

使用方法

授权您的客户端

const CERT_FILE_NAME = 'my-api-key-private-cert.pem';
const API_KEY = '0b70012a-5a7a-2b90-815a-aa73a7f8001a'; // My API Key
const API_BASE = 'https://api.commercesignals.com/';

$api = new CommerceSignals\API(API_BASE, [
  'apiKey' => API_KEY,
  'cert' => file_get_contents(__DIR__ . '/' . CERT_FILE_NAME)
]);

API 类

主要的 API 类用于构建要发布的 API 请求。

API 调用的方法可以链接起来以创建您正在制作的请求的部分。每个链接的方法都有一个可选的 $id 参数，可以将它传递给请求段的一部分以获取特定的资源。调用中的最后一个方法确定正在进行的 HTTP 请求的类型，并且有一个可选的 $payload 参数，它将用作请求体。

get() => GET request
update() => PATCH request
save() => POST or PUT (depending on if the payload BODY has an id set or not)

示例

  $api->signals('0a000337-574f-223e-8156-4f3a98e707a1')
    ->requests('0a00017c-5aac-1195-82ba-ae6ea3fa000a')
    ->results()
    ->get();

HTTP 请求

GET https://api.commercesignals.com/rest/v1/signals/0a00...07a1/requests/0a00...a000a/results

commercesignals / csapi-php

维护者

详细信息