Langsung ke konten

API REST Barang Berbahaya

API REST JSON DGAssistant membuat kiriman barang berbahaya dari sistem manajemen atau logistik Anda sendiri dan mengembalikan deklarasi pengirim, daftar periksa, serta penandaan bungkusan yang telah diverifikasi sesuai regulasi yang berlaku. API ini ditujukan bagi perusahaan yang mengintegrasikan dokumen tersebut ke dalam ERP-nya, dan juga mencakup konsolidasi.

Apa yang dilakukan API

Koneksi antara DGAssistant dan sistem manajemen

Kiriman. API REST JSON DGAssistant membuat kiriman barang berbahaya dari sistem manajemen atau logistik Anda sendiri dan mengembalikan deklarasi pengirim, daftar periksa, serta penandaan bungkusan yang telah diverifikasi berdasarkan regulasi yang berlaku. Sistem Anda menyimpan data komersial; DGAssistant menyediakan pengetahuan regulasi dan dokumennya.

Konsolidasi. API ini juga mencakup pengelompokan kiriman dari beberapa pengirim pada kedua sumbunya. Sumbu kontraktual adalah kiriman induk — pemesanan (booking), konsolidasi laut atau udara, atau pengelompokan muatan angkutan jalan (groupage) — beserta para pihaknya, referensinya, kiriman yang dilampirkan padanya, perubahan statusnya, dan riwayatnya. Sumbu fisik adalah peralatan pengangkutan (peti kemas, kendaraan, kereta gandengan, atau perangkat satuan muatan) dan pergerakan pengangkutan (pelayaran, penerbangan, atau perjalanan darat) beserta persinggahannya, bersama dengan kapal, kendaraan, dan lokasi milik akun. Lebih dari separuh layanan ini dikhususkan untuk bagian tersebut.

Buka Spesifikasi API Barang Berbahaya

Dua cara kerja: sekaligus (batch) dan interaktif

Sekaligus (batch). Satu panggilan memuat spesifikasi lengkap kiriman beserta seluruh barangnya. Cara ini ditujukan bagi sistem manajemen dan logistik yang mengirimkan kiriman utuh yang sudah tersusun.

Interaktif. Kiriman dibuka terlebih dahulu, lalu barang ditambahkan satu per satu. Setiap respons memuat pesan validasi atas barang yang baru saja ditambahkan, sehingga aplikasi Anda sendiri dapat menampilkannya kepada pengguna selama kiriman disiapkan.

Data yang telah ditentukan atau data seketika

Data yang telah ditentukan. Produk dan pihak terkait — pengirim, pengangkut, penerima, pemuat, dan pengemudi — dibuat terlebih dahulu dan API menggunakan kodenya. Ini adalah cara kerja paling sederhana dan yang kami rekomendasikan, karena klasifikasi regulasi ditetapkan satu kali dan digunakan kembali di setiap kiriman.

Data seketika. Produk dan pihak terkait didefinisikan dalam panggilan yang juga membuat kiriman. Cara ini sesuai untuk sistem yang tidak memiliki katalog sendiri atau yang mengirimkan barang secara sesekali.

Dokumen yang dikembalikan

API mengembalikan dokumen yang sama dengan yang dihasilkan aplikasi. Dokumen kiriman dan konsolidasi diperoleh dalam format PDF, XLSX, atau DOCX, dan dokumen kiriman juga dapat dikirim melalui surel langsung dari layanan tersebut; dokumen surat muatan diperoleh dalam format PDF.

  • Untuk setiap kiriman: dokumen pengangkutan sesuai regulasi yang berlaku —dokumen pengangkutan ADR, Deklarasi Barang Berbahaya IMO atau formulir multimoda IMDG, dan Deklarasi Pengirim IATA—, daftar periksa, penandaan bungkusan dalam ukuran penuh atau dalam ukuran kecil yang disesuaikan, serta, untuk pengangkutan udara, lembar data surat muatan udara.
  • Untuk kiriman induk: manifes konsolidasi, daftar peti kemas, daftar bungkusan setiap unit, lembar muatan per pengirim, dan lembar data dokumen induk.
  • Untuk unit transportasi: sertifikat pengemasan peti kemas atau kendaraan, formulir barang berbahaya multimoda, ringkasan barang berbahaya pada unit, daftar periksa sebelum sertifikat ditandatangani, dan label konsolidasi.
  • Untuk perjalanan: manifes barang berbahaya, laporan pemisahan antarunit di atas sarana angkut, laporan ambang batas pengecualian ADR 1.1.3.6, lembar pembatasan perjalanan, lembar muatan, pemberitahuan kepada kapten (NOTOC), dan dokumen pengangkutan terkonsolidasi untuk kendaraan.
  • Untuk surat muatan: draf, salinan yang telah ditandatangani, dokumen pengangkutan ADR yang dilampirkan, dan laporan bukti.

Apa yang diverifikasi API

Pada kiriman. Pemisahan antarbarang yang diangkut bersama, batas kuantitas instruksi pengemasan yang berlaku serta ketentuan kuantitas terbatas dan kuantitas dikecualikan, keberterimaan barang untuk moda pengangkutan, keabsahan kemasan, dan kelengkapan deklarasi. Jika ada hal yang tidak memenuhi ketentuan, respons menyebutkan aturan yang tidak dipenuhi beserta nilai-nilainya, sehingga pesan tersebut dapat ditampilkan di aplikasi Anda sendiri.

Pada konsolidasi. Pemisahan di dalam unit transportasi, pemisahan antarunit yang dimuat dalam pergerakan yang sama, perhitungan ambang batas 1.1.3.6 ADR untuk pergerakan tersebut beserta rinciannya, serta pembatasan perjalanan yang dikembalikan sebagai data, seperti kode pembatasan terowongan atau keberadaan barang berbahaya berkonsekuensi tinggi.

Regulasi dan jenis pengangkutan yang dicakup

ADR untuk angkutan jalan, IMDG untuk angkutan laut, IATA untuk angkutan udara, dan 49 CFR. Ketiga regulasi utama dikelola secara terpadu, bukan sebagai modul terpisah, sehingga kiriman yang berganti moda pengangkutan tidak perlu disiapkan ulang.

Pengemasan campuran, overpack, tangki, pengangkutan curah, kemasan kosong yang belum dibersihkan, limbah, bahan peledak Kelas 1 —beserta massa bersih bahan peledak per bungkusan— dan zat radioaktif Kelas 7, semuanya didukung dengan data yang diperlukan masing-masing. Teks dokumen diterbitkan dalam sembilan belas bahasa.

Ketersediaan API

Layanan ini dipublikasikan di tiga wilayah — Eropa, Amerika, dan Asia-Pasifik — masing-masing dengan alamatnya sendiri, sehingga integrasi bekerja dengan wilayah tempat akun berada. Infrastrukturnya redundan dan dipantau sepanjang waktu.

Cara mulai menggunakan API

Ajukan permintaan uji coba gratis selama dua minggu beserta kredensial layanannya. Autentikasi menggunakan OAuth 2.0 dengan jenis grant client credentials: sistem Anda memperoleh token akses dan mengirimkannya pada setiap permintaan.

Spesifikasi lengkapnya dipublikasikan dalam format OpenAPI dan dapat dibaca, dijelajahi, serta digunakan untuk membuat klien dalam bahasa pemrograman Anda sendiri sebelum menulis satu baris pun kode integrasi.

Bagian spesifikasi API

Bagian
IkhtisarPengenalan API dan batas penggunaannya, beserta berkas OpenAPI 3.0 dan 2.0 dari spesifikasi dan indeks semua bagiannya.Buka
AutentikasiToken akses OAuth2 yang diterbitkan dengan jenis grant client credentials, sebagai alternatif autentikasi HTTP Basic untuk setiap operasi yang memerlukan autentikasi.Buka
Pemeriksaan koneksiPemeriksaan ketersediaan API, kredensial pengguna API, serta permintaan dengan dan tanpa autentikasi.Buka
Data indukBarang berbahaya dan radionuklida, kemasan dan instruksi pengemasan, kode, negara, dan lokasi yang dirujuk oleh kiriman, produk, dan konsolidasi.Buka
ProdukProduk sederhana dan produk pengemasan campuran dalam katalog, termasuk pembuatan produk pengemasan campuran secara interaktif untuk sebuah kiriman.Buka
Pihak terkaitPihak terkait yang telah ditentukan: pengirim, penerima, pemuat, pengangkut, pemasok, dan pengemudi.Buka
Kendaraan, kereta gandengan, dan kapalKendaraan, kereta gandengan, dan kapal milik akun, beserta registrasi kendaraan, jenis kendaraan ADR, dan dokumen kepatuhannya.Buka
Lokasi dan pembatasanPelabuhan, bandar udara, dan terminal milik akun, serta pembatasan yang berlaku ketika peralatan pengangkutan direncanakan atau dimuat di sana.Buka
KirimanPembuatan kiriman dengan seluruh isinya (sekaligus) atau dengan isi pertamanya (interaktif), serta pengambilan dan penghapusan kiriman.Buka
Isi kirimanProduk, pengemasan campuran, dan overpack yang ditambahkan ke atau dihapus dari kiriman yang diproses secara interaktif.Buka
Dokumen kirimanDokumen sebuah kiriman (dokumen pengangkutan, daftar periksa, penandaan bungkusan, dan lainnya), pengirimannya melalui surel, serta dokumen yang dibekukan.Buka
Surat muatanSurat muatan CMR, elektronik (e-CMR), dan domestik, mulai dari pemeriksaan cakupan Protokol e-CMR atas rute hingga penerbitan, penyerahan, dan pembatalan.Buka
Permintaan konsolidasiPermintaan konsolidasi dari akun klien, atau dari penasihat keselamatan mereka atas nama mereka, serta keputusan pihak konsolidator.Buka
Kiriman indukKiriman induk beserta kirimannya dan alur persetujuannya.Buka
Peralatan pengangkutanPeralatan pengangkutan, isinya, pemeriksaan pemisahannya, dan riwayat pergerakannya.Buka
Pengangkutan dan persinggahanPelayaran, penerbangan, dan perjalanan darat beserta persinggahan dan peralatan pengangkutannya, pemeriksaan pemisahan, perhitungan ambang batas muatan (ADR 1.1.3.6), dan pembatasan.Buka
Dokumen konsolidasiDokumen kiriman induk, peralatan pengangkutan, dan pengangkutan.Buka
WebhookLangganan webhook milik akun, pengujiannya, dan pengiriman terbarunya.Buka

Untuk melihat betapa cepat dan mudahnya integrasi, Anda dapat mencobanya selama dua minggu tanpa kewajiban apa pun