README

用于从 PHP 应用程序访问 JNE API 的非官方库。

• 安装
• 用法
  • 设置用户名和 API 密钥
  • 设置生产模式
• 用法和示例
  • 运费
    • 获取运费
  • JNE 在线预订号
    • 创建 JOB
  • 航空货运单
    • 注册航空货运单号
  • 追踪
    • 跟踪包裹
• 贡献

安装

使用以下命令通过 composer 安装 jne-php

composer require yusufthedragon/jne-php

或者手动在您的 composer.json 文件中添加它。

用法

设置用户名和 API 密钥

使用从 JNE 获得的账户用户名和 API 密钥设置包。

\YusufTheDragon\JNE\JNE::setUsername('username')->setApiKey('apiKey');

设置生产模式

当将您的应用程序部署到生产环境时，您可能希望也将 API 端点设置为生产环境，通过设置 setProductionMode 为 true。

\YusufTheDragon\JNE\JNE::setProductionMode(true);
// or chain it
\YusufTheDragon\JNE\JNE::setUsername('username')->setApiKey('apiKey')->setProductionMode(true);

用法和示例

运费

获取运费

根据起点和终点代码检索可用运费。

\YusufTheDragon\JNE\Fare::getFares(array $parameters);

用法示例

$params = [
    'from' => 'CGK10000',
    'thru' => 'BDO10000',
    'weight' => 1
];

$getFares = \YusufTheDragon\JNE\Fare::getFares($params);

var_dump($getFares);

JNE 在线预订号

创建 JOB

\YusufTheDragon\JNE\JOB::create(array $parameters);

用法示例

$params = [
    'SHIPPER_NAME' => 'John Doe',
    'SHIPPER_ADDR1' => 'Jl. Custom Address No. 10',
    'SHIPPER_CITY' => 'JAMBI',
    'SHIPPER_ZIP' => '36136',
    'SHIPPER_REGION' => 'JAMBI',
    'SHIPPER_COUNTRY' => 'INDONESIA',
    'SHIPPER_CONTACT' => 'John Doe',
    'SHIPPER_PHONE' => '+6287793443322',
    'RECEIVER_NAME' => 'Jane Doe',
    'RECEIVER_ADDR1' => 'Jl. Custom Address No. 20',
    'RECEIVER_CITY' => 'TANGERANG SELATAN',
    'RECEIVER_ZIP' => '31264',
    'RECEIVER_REGION' => 'BANTEN',
    'RECEIVER_COUNTRY' => 'INDONESIA',
    'RECEIVER_CONTACT' => 'Jane Doe',
    'RECEIVER_PHONE' => '+6287793443322',
    'ORIGIN_DESC' => 'Custom Description',
    'ORIGIN_CODE' => 'CGK10100',
    'DESTINATION_DESC' => 'Dummy Description',
    'DESTINATION_CODE' => 'CGK10101',
    'SERVICE_CODE' => 'REG',
    'WEIGHT' => 1,
    'QTY' => 1,
    'GOODS_DESC' => 'Goods Description',
    'DELIVERY_PRICE' => 9000,
    'BOOK_CODE' => 'NT-52744198231'
];

$createJOB = \YusufTheDragon\JNE\JOB::create($params);

var_dump($createJOB);

航空货运单

注册航空货运单号

\YusufTheDragon\JNE\AirWayBill::register(array $parameters);

用法示例

$params = [
    'ORDER_ID' => '',
    'AWB_NUMBER' => ''
];

$registerAWB = \YusufTheDragon\JNE\AirWayBill::register($params);

var_dump($registerAWB);

追踪

跟踪包裹

\YusufTheDragon\JNE\Tracking::trace(string $awbNumber);

用法示例

$tracePackage = \YusufTheDragon\JNE\Tracking::trace('0114541900204500');

var_dump($tracePackage);

许可证

此库是开源软件，许可协议为 GPL-3.0-only License。

贡献

对于任何请求、错误或评论，请打开 问题 或 提交拉取请求。