yusufthedragon/jne-php

PHP Clients for JNE API

0.5.0 2020-11-17 10:32 UTC

Requires

• php: >=7.2.0
• guzzlehttp/guzzle: >=6.0

GPL-3.0-only

• Yusuf The Dragon

• JNE

README

Unofficial library for access JNE API from PHP applications.

• Installation
• Usage
  • Set the Username and API Key
  • Set the Production Mode
• Usages and Examples
  • Fare
    • Get Fares
  • JNE Online Booking Number
    • Create JOB
  • AirWayBill
    • Register AirWayBill Number
  • Tracking
    • Trace the Package
• Contributing

Installation

Install jne-php with composer by following command:

composer require yusufthedragon/jne-php

or add it manually in your composer.json file.

Usage

Set the Username and API Key

Setup the package with your account's username and api key obtained from JNE.

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

Set the Production Mode

When deploying your application to production, you may want to change API Endpoint to production as well by setting setProductionMode to true.

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

Usages and Examples

Fare

Get Fares

Retrieve available fares based on origin and destination code.

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

Usage example:

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

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

var_dump($getFares);

JNE Online Booking Number

Create JOB

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

Usage example:

$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' => '[phone]',
    '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' => '[phone]',
    '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);

AirWayBill

Register AirWayBill Number

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

Usage example:

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

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

var_dump($registerAWB);

Tracking

Trace the Package

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

Usage examples

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

var_dump($tracePackage);

License

This library is open-sourced software licensed under the GPL-3.0-only License.

Contributing

For any requests, bugs, or comments, please open an issue or submit a pull request.