README

Trackmage - 您的商店的跟踪页面。美观、品牌化、可定制。

TrackMage SDK for php

TrackMage 是您迄今为止最自动化的运输跟踪工具。发现简单地向客户展示包裹位置、提供支持并获得更多好评的方式

入门

1. 创建 TrackMage 账户 – 首先您需要 注册 TrackMage 账户并获取 clientId 和 clientSecret。
2. 最低要求 – 运行 SDK 您需要安装 PHP >= 5.6。我们强烈推荐使用 v7.2 或更高版本。
3. 安装 SDK – 使用 [Composer] 是推荐安装 TrackMage SDK for PHP 的方式。SDK 作为 trackmage/trackmage-sdk-php 包在 Packagist 上提供

   composer require trackmage/trackmage-sdk-php
   

4. 查看文档 有 API 文档 和 Swagger 参考

快速示例

创建客户端

use TrackMage\Client\TrackMageClient;

$clientId = '<client-it>';
$clientSecret = '<client-secret>';
$client = new TrackMageClient($clientId, $clientSecret);

发布跟踪号码

$workspaceId = 100;

$response = $client->post('/shipments', ['json' => [
    'workspace' => '/workspaces/'.$workspaceId,
    'trackingNumber' => 'TN-1',
]]);
$shipment = TrackMageClient::item($response);

$response = $client->get('/workspaces/'.self::$workspaceId.'/shipments');
$shipments = TrackMageClient::collection($response);

获取工作空间列表

$response = $client->get('/workspaces/'.$workspaceId.'/shipments');
$workspaces = TrackMageClient::collection($response);

获取承运商列表

$response = $client->get('/public/carriers');
$carriers = TrackMageClient::collection($response);

创建 webhook

这里有 webhook 处理器示例，您需要在您的端上使其可访问。

$workflow = [
    'type' => 'webhook',
    'period' => 'immediately',
    'title' => 'Webhook for testing',
    'workspace' => '/workspaces/<id>',
    'enabled' => true,
    'concurrency' => '1',
    'url' => 'http://acme.example',
    'authType' => 'basic',
    'username' => 'webhook_user',
    'password' => 'password',
    'notificationEmails' => [
        'test@email.com', 'test-2@email.com',
    ],
];
$response = $client->post('/workflows', ['json' => $workflow]);
$workflow = TrackMageClient::item($response);
$workflowId = $workflow['id'];

测试

运行单元测试

composer update
./vendor/bin/phpunit

phpstan

vendor/bin/phpstan analyse -c phpstan.neon
vendor/bin/phpstan analyse -c phpstan-tests.neon