dokumen api - industri - pomttac.pom.go.id/storage/files/publication/pdf-5ee6fe61669...expired date...

Dokumentasi API - Industri Versi 2.0

DOKUMEN API - INDUSTRI

IMPLEMENTASI SOLUSI TEKNOLOGI PENGAWASAN OBAT DAN

MAKANAN BERBASIS DIGITAL

BPOM - 2019

Dokumentasi API - Sarana Versi 2.0

1

DAFTAR ISI

DAFTAR ISI ............................................................................................................................................... 1

GAMBARAN UMUM ................................................................................................................................ 2

1. TUJUAN DOKUMENTASI API ............................................................................................................ 2

2. GAMBARAN APLIKASI ...................................................................................................................... 2

3. API .................................................................................................................................................... 4

3.1. Login .......................................................................................................................................... 4

3.2. Kirim Produk ............................................................................................................................. 5

3.3. Daftar Sarana ............................................................................................................................ 6

3.4. Request Barcode melalui Website ........................................................................................... 6

3.5. Request Barcode Parent melalui API ....................................................................................... 7

3.6. Request Barcode Primer melalui API ....................................................................................... 7

3.7. Bulk Upload CSV Barcode ......................................................................................................... 8

3.8. Barcode Rejected....................................................................................................................10

3.9. Barcode Sampling ...................................................................................................................10

3.10. Barcode Activation .................................................................................................................11

3.11. Barcode Packaging Aggregate ................................................................................................12

3.12. Barcode Delete Reference .....................................................................................................12

3.13. Terima Produk ........................................................................................................................13

4. Cara Penggunaan Postman ............................................................................................................14

4.1. Login dengan Postman ...........................................................................................................15


2

GAMBARAN UMUM

Teknologi pengawasan obat dan makanan berbasis digital oleh Badan POM RI memiliki

tujuan secara umum, yaitu:

a. Meningkatkan mutu layanan publik melalui pemanfaatan teknologi informasi;

b. Mempermudah pengawasan obat dan makanan (market control) mulai dari industri

sampai beredar di kalangan masyarakat;

c. Menekan angka peredaran obat dan makanan illegal atau palsu di masyarakat;

d. Perbaikan organisasi, sistem manajemen, dan proses kerja antara BPOM RI dengan

perusahaan rekanan.

1. TUJUAN DOKUMENTASI API

Dokumen ini disusun untuk membantu dan memudahkan pihak industri dalam proses

integrasi sistem yang dimiliki dengan sistem milik Badan POM RI. Dokumentasi disusun khusus

dengan special karakter.

2. GAMBARAN APLIKASI

Sistem teknologi pengawasan obat dan makanan berbasis digital dikembangkan

menggunakan teknologi SOA (Service Oriented Architecture). Teknologi ini berupa RESTful API

(Application Programming Interface). Pertukaran data menggunakan format JSON (JavaScript

Object Notation).

Pada tahap development terdapat beberapa URL yang perlu diperhatikan yaitu:

a. Untuk login ke dashboard untuk melihat interface aplikasi bisa melalui URL

http://ttac.pom.go.id

Web Server

API Server

Database Server Clients

HTTP REQUEST

HTTP RESPONSE

Gambar 1 Gambaran Umum Aplikasi

https://ttac.pom.go.id/

http://52.76.76.251/bpom/public/auth/sarana/login

http://52.76.76.251/bpom/public/auth/sarana/login


3

untuk login disertakan dalam email

b. Untuk penggunaan API bisa di test menggunakan aplikasi RESTFULL API Tester seperti

Postman, untuk referensi penggunaannya bisa lihat pada poin 5


4

3. API

Dalam proses interaksi data antar server melalui API, dan khusus untuk barcode dengan special

karakter dapat menggunakan format TEXT dalam input parameter, seperti Gambar 2. Penggunaan

format tersebut tidak berlaku untuk proses autentifikasi (Login) dan daftar sarana.

Gambar 2 Form-data TEXT

3.1. Login

Berfungsi untuk autentikasi pengguna ke dalam sistem. Setiap sarana memiliki token, dan

token tersebut akan expired dalam 30 hari.

URL http://ttac.pom.go.id/api/v2/auth/login

TIPE POST

FORMAT JSON

a. Parameter Input

email [string] Email pengguna

password [string] password pengguna

Contoh format JSON untuk request:

{

"email": [email protected],

"password": "inipassword"

}

b. Respon

Respon {

"status": "success",

"role": "sarana",

"user": {

"id": xxx,

"id_rekanan": xxx,

"name": "NAMA INDUSTRI",

"phone": "xxxxxxxxx",

"email": "[email protected]",

"token": "xxxxxxxx",

"created_at": null,

"updated_at": null,


5

"deleted": 0,

"status": true,

"sarana": {

"id": xxx,

"id_group": 1,

"nama_rekanan": "NAMA INDUSTRI",

"alamat_rekanan": "Alamat Industri",

"no_telp": xxxxx,

"fax": xxxxx,

"provinsi": xx,

"kota": xxxx,

"latitude": "xxx.xxx.xxx",

"longitude": "xxx.xxx.xxx",

"status": true,

"logo_rekanan": null,

"created_at": null,

"updated_at": null,

"deleted": 0,

"file_dokumen": null

}

}

}

Status 200

3.2. Kirim Produk

Berfungsi untuk mengirim data produk (barcode) ke sarana distribusi tujuan.

URL http://ttac.pom.go.id/api/v2/barcode/send

TIPE POST

FORMAT JSON

a. Parameter Input

token [string] token masing-masing sarana

id_sarana_tujuan [int] id_sarana_tujuan

barcode [array string] Array barcode berdasarkan scan dari aplikasi

Contoh format JSON untuk request: { "token":"token_anda", "id_sarana_tujuan":"900", "barcode":["XXXXXXXXXXXXXXXXX"] } b. Respon

Respon {

"status": "success"

} Status 200


6

3.3. Daftar Sarana

Berfungsi untuk mendapatkan semua daftar sarana

URL http://ttac.pom.go.id/api/v2/saranalist?token=token_anda

TIPE GET

FORMAT JSON

a. Respon

Respon [

{

"id": xxx,

"id_group": 3,

"nama_rekanan": "Nama Sarana",

"alamat_rekanan": "Alamat Sarana",

"no_telp": xxxxx,

"fax": xxxxx,

"provinsi": xx,

"kota": xxxx,



"status": true,


"created_at": null,

"updated_at": null,

"deleted": 0,


},

{

"id": xxx,

"id_group": 3,

"nama_rekanan": "Nama Sarana",

"alamat_rekanan": "Alamat Sarana",

"no_telp": xxxxx,

"fax": xxxxx,

"provinsi": xx,

"kota": xxxx,



"status": true,


"created_at": null,

"updated_at": null,

"deleted": 0,


}

]

Status 200

3.4. Request Barcode melalui Website

Berfungsi untuk mendapatkan data barcode sesuai dengan spesifikasi produksi yang

akan dilakukan. Url dibawah harus dibuka setelah melakukan login terlebih dahulu:


7

URL http://ttac.pom.go.id/sarana-dashboard/barcode/request

DATA Data produk (memilih data yang sudah terdaftar di CEKBPOM)

Nomor Batch (alphanumeric 10)

Expired Date (yyyy/mm/dd)

Quantity (number)

GTIN (14digit number, optional)

3.5. Request Barcode Parent melalui API

Berfungsi membantu melaporkan kemasan sekunder/tersier produk barcode yang telah

diproduksi dan siap untuk didistribusikan ke jalur distribusi selanjutnya.

URL http://ttac.pom.go.id/api/v2/barcode/registerparent

TIPE POST

FORMAT JSON

a. Parameter Input


barcode [array string] barcode berdasarkan scan dari aplikasi

is_active [boolean] status barcode yang akan diaktivasi

barcode_level [string] barcode berdasarkan level yang ditentukan oleh Industri (“sekunder”, “tersier)

b. Parameter Tambahan (opsional)

parent [string] barcode parent dari produk yang dilaporkan tersebut. (Barcode parent harus sudah diregistrasi sebelumnya).

Contoh format JSON untuk request: {

"token":"token_anda",

"barcode":["XXXXX\u001dXX\u001dTEST12092019SEK1","

XXXXX\u001dXX\u001dTEST12092019SEK2"],

"is_active":true,

"barcode_level":"sekunder",

"parent":"XXXXX\u001dXXXXXX\u001dTEST12092019TER1"

}

3.6. Request Barcode Primer melalui API

Berfungsi membantu melaporkan produk barcode primer yang telah diproduksi dan siap

untuk didistribusikan ke jalur distribusi selanjutnya.


8

URL http://ttac.pom.go.id/api/v2/barcode/register

TIPE POST

FORMAT JSON

a. Parameter Input Wajib


barcode [array string] barcode berdasarkan scan dari aplikasi

nie [string] nie berdasarkan produk yang telah terdaftar

exp_date [string] tanggal kedaluwarsa produk, (Tahun-Bulan-Tanggal)

gtin [string] gtin yang telah didaftarkan sesuai standar internasional

is_active [boolean] status barcode yang akan diaktivasi

is_sample [boolean] status barcode yang akan dijadikan sample produk

is_reject [boolean] status barcode yang akan direject

id_kemasan [string] kemasan produk berdasarkan


parent [string] barcode parent dari produk yang dilaporkan tersebut. (Barcode parent harus sudah diregistrasi sebelumnya).

lot_no [string] lot_no yang ditentukan Industri (opsional)

batch_no [string] batch_no yang ditentukan Industri (opsional)



"barcode":["XXXXXX\u001dXXXXXX\u001dTEST12092019PRIM1","XXXXXX\

u001dXXXXXX\u001dTEST12092019PRIM2"],

"nie":"DKL0434534543",

"lot_no":"1309",

"batch_no":"T1309",

"exp_date":"2020-12-20",

"gtin":"8994957000270",

"is_active":false,

"is_sample":false,

"is_reject":false,

"id_kemasan":"DUS, 10 VIAL @ 5 DOSIS (2,5 ML)"

}

3.7. Bulk Upload CSV Barcode

Berfungsi untuk melaporkan data barcode dalam bentuk CSV dengan isi sebagai berikut:

Barcode String: berisikan serialisasi data barcode yang akan dilaporkan

NIE

Expired Date (yyyy/mm/dd)


9

Batch No

GTIN (14 digit number, optional)

is_active: status aktif

is_sample: status sample

is_reject: status reject

Setelah melakukan submit data CSV ini maka otomatis data akan masuk kedalam sistem

dan bisa di cek melalui module "management barcode".


10

3.8. Barcode Rejected

Berfungsi untuk melakukan reject terhadap barcode hasil scan

URL http://ttac.pom.go.id/api/v2/barcode/reject

TIPE POST

FORMAT JSON



barcode [string] barcode berdasarkan scan dari aplikasi


latitude [string] Koordinat latitude lokasi obat (opsional)

longitude [string] Koordinat longitude lokasi obat (opsional)

Contoh format TEXT untuk request: {


"barcode":"XXXXXXXXXXXXXXXXXXXXXXXXXX",

"latitude":"0",

"longitude":"0"

}

c. Respon

Respon {

"message": "Successfully flag barcode as reject"

} Status 200

3.9. Barcode Sampling

Berfungsi untuk sampling scan barcode

URL http://ttac.pom.go.id/api/v2/barcode/sampling

TIPE POST

FORMAT JSON



barcode [string] barcode berdasarkan scan dari aplikasi





11



"barcode":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

"latitude":"0",

"longitude":"0"

}

c. Respon

Respon {

"message": "Successfully flag barcode as sample"

} Status 200

3.10. Barcode Activation

Berfungsi untuk aktivasi barcode

URL http://ttac.pom.go.id/api/v2/barcode/activation

TIPE POST

FORMAT JSON



barcode_string [string] barcode hasil scan




Contoh format JSON untuk request: { "token":"token_anda", "barcode":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "latitude":"0", "longitude":"0" } c. Respon

Respon {

"message": "Activation Success"

} Status 200


12

3.11. Barcode Packaging Aggregate

Berfungsi untuk agregasi barcode, barcode yang telah ada atau diupload pada sistem BPOM.

Barcode berupa barcode tersier, sekunder, dan primer.

URL http://ttac.pom.go.id/api/v2/barcode/packingaggregate

TIPE POST

FORMAT JSON



parent [string] barcode yang menjadi parent

parent_type [string] jenis kemasan parent (“sekunder” atau “tersier”)

child [Array string] barcode-barcode yang menjadi child dari barcode parent

packing_date [date] Tanggal pengemasan dengan format (Tahun-Bulan-Tanggal)

Contoh format JSON untuk request: { "token":"token_anda", "parent":"XXXXXXXXXXXXXXXXXXXXX” "latitude":"0", "longitude":"0", "parent_type":"sekunder", "child":["AAAAAAA","BBBBBBB","CCCCCCCC"], "packing_date":"2019-12-25" } b. Respon

Respon {

"success": "Child added successfully"

} Status 200

3.12. Barcode Delete Reference

Berfungsi untuk menghapus referensi ke parent barcode dari sebuah child barcode tertentu.

URL http://ttac.pom.go.id/api/v2/barcode/deletereference

TIPE POST

FORMAT JSON

a. Parameter Input



13

barcode [string] barcode child yang ingin dihapus referensinya

Contoh format JSON untuk request: { "token":"token_anda", "barcode":"XXXXXXXXXXXXXXXXXXXXXX" } b. Respon

Respon {

"success": " Barcode reference successfully deleted" }

Status 200

3.13. Terima Produk

Berfungsi untuk menerima data produk (barcode) retur dari sarana distribusi.

URL http://ttac.pom.go.id/api/v2/barcode/receive

TIPE POST

FORMAT JSON

c. Parameter Input


barcode [Array String] Barcode dari scan aplikasi

Contoh format JSON untuk request: { "token":"token_anda", "barcode":["XXXXXXXXXXXXXXXXX",”XXXXXXXXXXXXXX”] } d. Respon

Respon {

"success": " Product is received" }

Status 200


14

4. Cara Penggunaan Postman

a. Buka aplikasi postman yang telah ada;

b. Masukkan URL API pada kolom “enter request URL”;

c. Pilih tipe:

a) GET

Untuk tipe GET, setelah memasukkan URL langsung klik tombol “Send” dan akan terlihat

hasilnya.

b) POST

I. Pilih tipe POST;

II. Masukkan URL;

III. Klik pada tab “Body”.

IV. Pilih format menjadi JSON

V. Pada bagian raw data isi datanya seperti gambar berikut (hanya contoh);

Pengisian data bisa juga lewa form-data (contoh):


15

VI. Klik tombol “Send” dan lihat hasilnya.

4.1. Login dengan Postman

a. Buka Postman;

b. Masukkan URL pada bagian “enter request URL”;

c. Pilih tipe menjadi POST;

d. Klik tab Body dan pilih raw dengan tipe format JSON;

e. Klik Send.

dokumen api - industri - pomttac.pom.go.id/storage/files/publication/pdf-5ee6fe61669...expired date...

Documents