jeroenboesten/shops-united-laravel

ShopsUnited API的Laravel封装器

v1.1.2 2020-04-04 10:34 UTC

This package is auto-updated.

Last update: 2024-09-04 19:48:43 UTC


README

Latest Version on Packagist Scrutinizer Code Quality StyleCI Total Downloads

此Laravel包作为Shops United API的封装器。要了解更多关于特定API的信息,请访问:Shops United API 文档。

此包与Shops United无任何关联、资助或关联,仅是业余时间维护。

安装

您可以通过composer安装此包

composer require jeroenboesten/shops-united-laravel

环境变量

将UserId和API Key添加到您的环境变量中。

SHOP_UNITED_ACCOUNT_ID=
SHOP_UNITED_API_KEY=

可选地,您可以通过添加环境变量来设置是否应验证ssl证书。默认情况下,生产环境上会验证ssl证书,但本地环境不会验证。

SHOPS_UNITED_VERIFY_SSL=true

使用方法

安装包后,您可以通过创建一个实例开始使用它。之后,您可以选择可用的模块之一(ShipmentsAccounts)并使用其中的方法。

    $shopsUnited = new \JeroenBoesten\ShopsUnitedLaravel\ShopsUnitedLaravel(); // Create a new ShopsUnitedLaravel instance.
    $shopsUnited->accounts()->validate(); // Validates the API Key and User ID.
    $shopsUnited->shipments()->types(); // List all types of shipments that are available for the account, can be used for creating a new shipment.
    $shopsUnited->shipments()->list(); // Lists last 50 shipments.

要使用API创建新的运单,您可以使用Shipments()->create()方法,首先提供必需的字段,然后是包含可选参数的数组(有关可选参数的列表,请访问API 文档)。

$shopsUnited->shipments()->create("PostNL", "Standaard pakket", "Order Aanvraag: 1502", "Arno Niem", "Straatweg", "14", "1111AB", "Amsterdam", 1, 1, ['NietLeverenBijDeBuren' => true])

变更日志

请参阅CHANGELOG以获取最近更改的更多信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全性

如果您发现任何与安全性相关的问题,请通过info@jeroenboesten.nl发送电子邮件,而不是使用问题跟踪器。

致谢

许可协议

MIT 许可协议 (MIT)。有关更多信息,请参阅许可文件