README

这是一个用于与shipcloud API交互的PHP库。

此库支持shipcloud版本v1中的以下实体

• 地址
• 承运人
• 默认退货地址
• 默认收货地址
• 发票地址
• 我
• 取货请求
• 运输报价
• 运输
• 跟踪器
• Webhooks

端点Rates不属于此库，因为它已弃用，将在后续版本中删除。请使用Shipment Quuotes代替。

此库是为PHP版本8.1+的PHP项目制作的。如果您正在寻找PHP版本在5.4到7.4之间的库，请尝试https://github.com/comyo-media/shipcloud-php

如何安装

此库可以通过composer安装

composer require djthossi/shipcloud-sdk

示例

您将在~/examples文件夹中找到所有API端点的示例。享受其中的乐趣。

Symfony中的使用

您想在symfony项目中使用此库并包括自动装配？安装后，只需将此代码添加到您的config/services.yaml

将此添加到services.yaml的参数部分

parameters:
  # shipcloud parameters
  app.SHIPCLOUD_API_KEY: "%env(SHIPCLOUD_API_KEY)%"

将此添加到services.yaml的服务部分

services:
  # shipcloud services
    DjThossi\ShipcloudSdk\Http\:
        resource: '../vendor/djthossi/shipcloud-sdk/src/Http'
        bind:
            $apiKey: '%app.SHIPCLOUD_API_KEY%'

    DjThossi\ShipcloudSdk\Api\:
        resource: '../vendor/djthossi/shipcloud-sdk/src/Api'
        arguments:
            $client: '@DjThossi\ShipcloudSdk\Http\Client'

之后，将包括您的个人API密钥的SHIPCLOUD_API_KEY添加到您的.env.local文件中，如下所示。

#shipcloud parameters
SHIPCLOUD_API_KEY=PUT_YOUR_KEY_HERE

现在您可以直接在您的业务逻辑中使用每个API。symfony将为您处理自动装配。

<?php
declare(strict_types=1);
namespace App\Controller;

use DjThossi\ShipcloudSdk\Api\MeApi;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class DefaultController extends AbstractController
{
    #[Route('/', name: 'homepage', methods: ['GET'])]
    public function index(MeApi $meApi): Response {
        var_dump($meApi->show()->getBodyAsArray());

        //...
    }
}

为此存储库做出贡献

有关更多详细信息，请点击这里