README

Sameday JSON API 文档

安装

您可以通过 composer 安装此包

composer require mchervenkov/sameday

如果您计划使用数据库存储品名

php artisan migrate

如果您需要导出配置文件

php artisan vendor:publish --tag=sameday-config

如果您需要导出迁移

php artisan vendor:publish --tag=sameday-migrations

如果您需要导出模型

php artisan vendor:publish --tag=sameday-models

如果您需要导出命令

php artisan vendor:publish --tag=sameday-commands

配置

SAMEDAY_ENV=test|production #default=test
SAMEDAY_AUTH_USERNAME= #default=test-sameday-username
SAMEDAY_AUTH_PASSWORD= #default=test-sameday-password
SAMEDAY_API_TEST_BASE_URI= #default=https://sameday-api-bg.demo.zitec.com
SAMEDAY_API_PRODUCTION_BASE_URI= #default=https://sameday-api.demo.zitec.com
SAMEDAY_API_TIMEOUT= #default=5

使用方法

方法

// Init Sameday Client
$sameday = new Sameday();

// Client endpoints
$sameday->getServices();
$sameday->getPickupPoints();
$sameday->getAwbStatus();
$sameday->syncStatus();

// Geolocation endpoints
$sameday->getCounties();
$sameday->getCities();

// Lockers endpoints
$sameday->getLockers();

命令

#get counties with database (use -h to view options)
php artisan sameday:get-counties

#get cities with database (use -h to view options)
php artisan sameday:get-cities

#create cities map with other carriers in database  (use -h to view options)
php artisan sameday:map-cities

#get lockers with database (use -h to view options)
php artisan sameday:get-lockers 

#get sameday api status (use -h to view options)
php artisan sameday:api-status

模型

SamedayCity
SamedayCounty
SamedayApiStatus
SamedayLocker
CarrierCityMap

示例

无参数

$sameday = new Sameday();
$response = $sameday->getCities();
dd($response);

使用 Hydrator

$sameday = new Sameday();
$cityHydrator = new City(['countyCode' => 'BG']);
$response = $sameday->getCities($cityHydrator);
dd($response);

使用 Hydrator 和 分页器

$sameday = new Sameday();
$cityHydrator = new City(['countyCode' => 'BG']);
$paginator = new Paginator(1, 50);
$response = $sameday->getCities($cityHydrator, $paginator);
dd($response);

测试

在运行测试之前，请将您的 API 凭据设置在 sameday.php 配置文件中

composer test

变更日志

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

贡献

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

安全性

如果您发现任何与安全相关的问题，请通过电子邮件 mario.chervenkov@gmail.com 而不是使用问题跟踪器来报告。

致谢

• Mario Chervenkov
• silabg.com ❤️
• 所有贡献者

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅 许可证文件。