Node RajaOngkir

Node RajaOngkir is Node.js Library for RajaOngkir

Node RajaOngkir adalah Library Node.js untuk RajaOngkir

Saya hanya menambah dan memperbaharui repository yang sudah ada https://github.com/andhikamaheva/node-rajaongkir

Daftar Isi

Dokumentasi
Instalasi
Quick Start
Penggunaan
Cara Kontribusi
Lisensi

Dokumentasi

Silahkan buka halaman Wiki untuk dokumentasi penggunaan lengkap dari RajaOngkir Node.js

Instalasi

Persyaratan

Node.js versi 10 ke Atas
RajaOngkir Service (telah mendaftar di RajaOngkir.com dengan akun tipe Starter, Basic maupun Pro dan telah memiliki API Key)

Cara Install

npm install --save node-rajaongkir

Quick Start

Menampilkan Seluruh Provinsi (Starter)

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

RajaOngkir.getProvinces().then(function (result){
    // Aksi ketika data Provinsi berhasil ditampilkan
}).catch(function (error){
    // Aksi ketika error terjadi
});

Menampilkan Spesifik Provinsi (Starter)

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

var id = 1; // ID Provinsi
RajaOngkir.getProvince(id).then(function (result){
    // Aksi ketika data Provinsi berhasil ditampilkan
}).catch(function (error){
    // Aksi ketika error terjadi
});

Menampilkan Seluruh Kota (Starter)

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

RajaOngkir.getCities().then(function (result){
    // Aksi ketika data Kota berhasil ditampilkan
}).catch(function (error){
    // Aksi ketika error terjadi
});

Menampilkan Spesifik Kota (Starter)

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

var id = 1; // ID Kota
RajaOngkir.getCity(id).then(function (result){
    // Aksi ketika data Kota berhasil ditampilkan
}).catch(function (error){
    // Aksi ketika error terjadi
});

Menghitung Biaya Kirim (Starter)

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

var params = {
    origin: 501, // ID Kota atau Kabupaten Asal
    destination: 114, // ID Kota atau Kabupaten Tujuan
    weight: 1700, // Berat Barang dalam gram (gr)
    courirer: 'jne' // Kurir
};
RajaOngkir.getCosts(params).then(function (result){
    // Aksi ketika data Biaya berhasil ditampilkan
}).catch(function (error){
    // Aksi ketika error terjadi
});

Menghitung Biaya Kirim JNE (Starter)

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

var params = {
    origin: 501, // ID Kota atau Kabupaten Asal
    destination: 114, // ID Kota atau Kabupaten Tujuan
    weight: 1700 // Berat Barang dalam gram (gr)
};
RajaOngkir.getJNECost(params).then(function (result){
    // Aksi ketika data Biaya berhasil ditampilkan
}).catch(function (error){
    // Aksi ketika error terjadi
});

Penggunaan

Dalam RajaOngkir Node.js terdapat 3 jenis API yang dapat digunakan yaitu Starter, Basic, dan Pro sesuai dengan dokumentasi RajaOngkir.com. Untuk menjalankan masing - masing API tersebut Anda dapat menggunakan perintah sebagai berikut :

Starter

var RajaOngkir = require('node-rajaongkir').Starter('apiKey');

Tipe akun Starter memiliki beberapa fitur antara lain :

getProvinces() untuk menampilkan seluruh data Provinsi
getProvince(idProvinsi) untuk menampilkan data Provinsi berdasarkan ID / parameter ID
getCities() untuk menampilkan seluruh data Kota
getCity(idKota) untuk menampilkan data Kota berdasarkan ID / Parameter ID
getCosts(params) untuk menampilkan biaya pengiriman berdasarkan Parameter
getJNECost(params) untuk menampilkan biaya pengiriman Kurir JNE
getPOSCost(params) untuk menampilkan biaya pengiriman Kurir POS
getTIKICost(params) untuk menampilkan biaya pengiriman Kurir TIKI

Basic

var RajaOngkir = require('node-rajaongkir').Basic('apiKey');

Tipe akun Basic memiliki beberapa fitur antara lain :

getProvinces() untuk menampilkan seluruh data Provinsi
getProvince(idProvinsi) untuk menampilkan data Provinsi berdasarkan ID / parameter ID
getCities() untuk menampilkan seluruh data Kota
getCity(idKota) untuk menampilkan data Kota berdasarkan ID / Parameter ID
getCosts(params) untuk menampilkan biaya pengiriman berdasarkan Parameter
getJNECost(params) untuk menampilkan biaya pengiriman Kurir JNE
getPOSCost(params) untuk menampilkan biaya pengiriman Kurir POS
getTIKICost(params) untuk menampilkan biaya pengiriman Kurir TIKI
getRPXCost(params) untuk menampilkan biaya pengiriman Kurir RPX
getESLCost(params) untuk menampilkan biaya pengiriman Kurir ESL
getPCPCost(params) untuk menampilkan biaya pengiriman Kurir PCP
getInterOrigins() untuk menampilkan data Kota (asal pengiriman) yang tersedia untuk pengiriman internasional
getInterOrigin(idKota) untuk menampilkan data Kota (asal pengiriman) yang tersedia untuk pengiriman internasional berdasarkan ID Kota/Kabupaten
getInterDests() untuk menampilkan data Negara yang mendukung pengiriman internasional
getInterDest(idNegara) untuk menampilkan data Negara yang mendukung pengiriman internasional berdasarkan ID Negara
getTIKIInterConst(params) untuk menampilkan biaya pengiriman internasional melalui kurir TIKI
getPOSInterCost(params) untuk menampilkan biaya pengiriman internasional melalui kurir POS
getCurrency() untuk menampilkan informasi nilai tukar rupiah terhadap US dollar
getJNEWaybill(params) untuk melacak / mengetahui status pengiriman berdasarkan nomor resi JNE

Pro

var RajaOngkir = require('node-rajaongkir').Pro('apiKey');

Tipe akun Pro memiliki beberapa fitur antara lain :

getProvinces() untuk menampilkan seluruh data Provinsi
getProvince(idProvinsi) untuk menampilkan data Provinsi berdasarkan ID / parameter ID
getCities() untuk menampilkan seluruh data Kota
getCity(idKota) untuk menampilkan data Kota berdasarkan ID / Parameter ID
getSubdistrict(idKota) untuk menampilkan data Kecamatan berdasarkan ID / Parameter ID
getCosts(params) untuk menampilkan biaya pengiriman dari beberapa layanan pengiriman (kurir)
getCost(params) untuk menampilkan biaya pengiriman berdasarkan Parameter
getJNECost(params) untuk menampilkan biaya pengiriman Kurir JNE
getPOSCost(params) untuk menampilkan biaya pengiriman Kurir POS
getTIKICost(params) untuk menampilkan biaya pengiriman Kurir TIKI
getRPXCost(params) untuk menampilkan biaya pengiriman Kurir RPX
getESLCost(params) untuk menampilkan biaya pengiriman Kurir ESL
getPCPCost(params) untuk menampilkan biaya pengiriman Kurir PCP
getInterOrigins() untuk menampilkan data Kota (asal pengiriman) yang tersedia untuk pengiriman internasional
getInterOrigin(idKota) untuk menampilkan data Kota (asal pengiriman) yang tersedia untuk pengiriman internasional berdasarkan ID Kota/Kabupaten
getInterDests() untuk menampilkan data Negara yang mendukung pengiriman internasional
getInterDest(idNegara) untuk menampilkan data Negara yang mendukung pengiriman internasional berdasarkan ID Negara
getTIKIInterConst(params) untuk menampilkan biaya pengiriman internasional melalui kurir TIKI
getPOSInterCost(params) untuk menampilkan biaya pengiriman internasional melalui kurir POS
getCurrency() untuk menampilkan informasi nilai tukar rupiah terhadap US dollar
getJNEWaybill(params) untuk melacak / mengetahui status pengiriman berdasarkan nomor resi JNE

Kontribusi

Anda dapat Melaporkan issue (Kesalahan Program, Saran, dll) dengan membuat New Issue melalui halaman Issue
Anda juga dapat berkontribusi untuk Package ini dengan cara Pull Request

Lisensi

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

asyasyarif / node-rajaongkir Goto Github PK

node-rajaongkir's Introduction