undefined

{level1}.1. Products - Mendapatkan Detail Produk

Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB , harus ada, atau pasti selalu ada, contoh: *variabel.

Request

URL

https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products

HTTP Verb/Method

GET

Header

Nama ParameterTipe DataKeterangan

*Authorization

string

Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi.

Query String

Nama ParameterTipe DataKeterangan

*identifier

string

Isi sumber data yang ingin digunakan, seperti: kfa, nie, atau lkpp.

  • nie: Data Nomor Izin Edar (NIE) yang bersumber dari BPOM.

  • lkpp: Data inventaris, distribusi, pengelolaan, dan harga obat yang beredar bersumber dari Lembaga Kebijakan Pengadaan Barang/Jasa Pemerintah (LKPP).

  • kfa: Data kode unik produk farmasi dan alat kesehatan yang bersumber pada Kamus Farmasi dan Alat Kesehatan (KFA).

Contoh: kfa.

*code

string

Isi kode dari produk yang akan dicari.

Contoh: 93004418.

Response

Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.

2xx Success

Contoh Data

Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.
{
  "search_code": "93015993",
  "search_identifier": "kfa",
  "result": {
      "name": "Abacavir Sulfate 300 mg Tablet Salut Selaput (KIMIA FARMA)",
      "kfa_code": "93015993",
      "active": true,
      "state": "valid",
      "image": null,
      "updated_at": "2023-09-21 07:17:24",
      "farmalkes_type": {
          "code": "medicine",
          "name": "Obat",
          "group": "farmasi"
      },
      "ucum": {
          "cs_code": "mg",
          "name": "milligram"
      },
      "dosage_form": {
          "code": "BS077",
          "name": "Tablet Salut Selaput"
      },
      "controlled_drug": {
          "code": "3",
          "name": "Obat Keras"
      },
      "rute_pemberian": {
          "code": "O",
          "name": "Oral"
      },
      "uom": {
          "name": "Tablet"
      },
      "produksi_buatan": "lokal",
      "nie": "GKL2012431917A1",
      "nama_dagang": "ABACAVIR SULFATE",
      "manufacturer": "KIMIA FARMA TBK",
      "registrar": "KIMIA FARMA Tbk.",
      "generik": true,
      "rxterm": "abacavir",
      "dose_per_unit": 1,
      "fix_price": 7215.0,
      "het_price": 13297.0,
      "farmalkes_hscode": null,
      "tayang_lkpp": true,
      "kode_lkpp": "45463910",
      "score_tkdn": null,
      "score_bmp": null,
      "score_tkdn_bmp": null,
      "med_dev_jenis": null,
      "med_dev_subkategori": null,
      "med_dev_kategori": null,
      "med_dev_kelas_risiko": null,
      "klasifikasi_izin": null,
      "net_weight": null,
      "net_weight_uom_name": "g",
      "volume": null,
      "volume_uom_name": "mL",
      "atc_ddd": {
          "name": "0.6 g - O"
      },
      "atc_l1": {
          "name": "ANTIINFECTIVES FOR SYSTEMIC USE",
          "code": "J",
          "level": "1",
          "parent_code": false,
          "comment": null
      },
      "atc_l2": {
          "name": "ANTIVIRALS FOR SYSTEMIC USE",
          "code": "J05",
          "level": "2",
          "parent_code": "J",
          "comment": null
      },
      "atc_l3": {
          "name": "DIRECT ACTING ANTIVIRALS",
          "code": "J05A",
          "level": "3",
          "parent_code": "J05",
          "comment": null
      },
      "atc_l4": {
          "name": "Nucleoside and nucleotide reverse transcriptase inhibitors",
          "code": "J05AF",
          "level": "4",
          "parent_code": "J05A",
          "comment": null
      },
      "atc_l5": {
          "name": "Abacavir",
          "code": "J05AF06",
          "level": "5",
          "parent_code": "J05AF",
          "comment": null
      },
      "description": "<p>Abacavir secara kompetitif menghambat reverse transcriptase retrovirus, mengganggu DNA polimerase yang bergantung pada RNA virus HIV yang mengakibatkan penghambatan replikasi virus.<br></p>",
      "indication": "<p>Infeksi HIV</p><p>Dewasa: Dikombinasikan dengan antiretroviral lain: 300 mg dua kali sehari atau 600 mg sekali sehari.</p><p><br></p><p>Anak: 3 bln, berat badan 14 kg sampai &lt;20 kg: 150 mg dua kali sehari atau 300 mg sekali sehari; 20 kg sampai &lt;25 kg: 150 mg di pagi hari dan 300 mg di malam hari atau 450 mg sekali sehari; &gt;25 kg: Sama seperti dosis dewasa.</p>",
      "warning": "<p>Pasien dengan faktor risiko penyakit hati (misalnya obesitas) dan mereka yang memiliki faktor risiko penyakit jantung koroner (misalnya hipertensi, DM, merokok). Gangguan ginjal atau hati ringan. Kehamilan.<br></p>",
      "side_effect": "<p>Demam, ruam, batuk, sesak, lesu, malaise, sakit kepala, mialgia, gangguan GI, terutama mual, muntah, diare dan sakit perut; pankreatitis dan peningkatan nilai enzim hati, osteonekrosis, sindrom pemulihan kekebalan, MI, sindrom lipodistrofi. Jarang, eritema multiforme, sindrom Stevens-Johnson, nekrolisis epidermal toksik.</p><p>Berpotensi Fatal: Reaksi hipersensitivitas yang serius dan fatal dengan keterlibatan beberapa organ, asidosis laktat, dan hepatomegali berat dengan steatosis.</p>",
      "identifier_ids": [
          {
              "name": "ABACAVIR SULFATE",
              "code": "GKL2012431917A1",
              "source_name": "NIE BPOM",
              "url": null
          },
          {
              "name": "Abacavir Sulfate 300 mg Tablet Salut Selaput",
              "code": "93015993",
              "source_name": "Kamus Farmalkes (KFA – IHS)",
              "url": null
          }
      ],
      "packaging_ids": [
          {
              "name": "Dus isi 60",
              "kfa_code": "94021264",
              "pack_price": 0.0,
              "uom_id": "Tablet",
              "qty": 60.0
          }
      ],
      "product_template": {
          "kfa_code": "92000888",
          "name": "Abacavir Sulfate 300 mg Tablet Salut Selaput",
          "state": "valid",
          "active": true,
          "display_name": "Abacavir Sulfate 300 mg Tablet Salut Selaput",
          "updated_at": "2023-08-29 00:49:25"
      },
      "active_ingredients": [
          {
              "kfa_code": "91000651",
              "active": true,
              "state": "valid",
              "zat_aktif": "Abacavir",
              "kekuatan_zat_aktif": "300 mg",
              "updated_at": "2022-11-17 10:56:16"
          }
      ],
      "dosage_usage": [],
      "cvx_info": {},
      "replacement": {
          "product": null,
          "template": null
      },
      "tags": []
  }
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan data dengan format atau ketentuan yang tidak sesuai.

Contoh Data

{
  "detail": [{
      "loc": [
        "query",
        "identifier"
      ],
      "msg": "field required",
      "type": "value_error.missing"
    }, {
      "loc": [
        "query",
        "code"
      ],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

5xx Server Error (Content-Type: text/plain)

Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.

Contoh Data

Gateway Timeout

Contoh Penggunaan/Kode

Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.

cURL (Windows)

curl --insecure --location ^
  --header "Authorization: Bearer <access-token>" ^
  --header "Accept: application/json" ^
  --request GET ^
  "https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products?identifier=kfa&code=93004418"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Accept: application/json' \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products?identifier=kfa&code=93004418'

Postman

  1. Buat request baru menggunakan New  HTTP Request, atau klik tombol + untuk buat tab request baru.

  2. Masukkan request URL

    https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products
  3. Lalu pilih request method GET.

  4. Pada tab Auth:

  5. Pada tab Headers:

  6. Pada tab Params, di bagian Query Params:

  7. Klik tombol Send.

  8. Hasil response akan ditampilkan di bagian Response.

{level1}.2. Products - Pencarian Produk dengan Paginasi

Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB , harus ada, atau pasti selalu ada, contoh: *variabel.

Request

URL

https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products/all

HTTP Verb/Method

GET

Header

Nama ParameterTipe DataKeterangan

*Authorization

string

Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi.

Query String

Nama ParameterTipe DataKeterangan

*page

number

Isi dengan nomor halaman (page) yang diinginkan.

Contoh: 1.

*size

number

Isi dengan banyaknya data yang ingin ditampilkan dalam satu halaman (page).

Contoh: 100.

*product_type

string

Isi dengan kategori/jenis produk yang diinginkan.

Contoh: farmasi.

from_date

string

Isi dengan waktu mulai dengan format YYYY-MM-DD

Contoh: 2023-06-26.

to_date

string

Isi dengan waktu selesai dengan format YYYY-MM-DD

Contoh: 2023-06-26.

farmalkes_type

string

Isi dengan kategori/jenis farmalkes yang diinginkan.

Contoh: vaccine.

keyword

string

Isi dengan kategori/jenis produk yang diinginkan.

Contoh: glove.

template_code

string

Isi dengan kode produk virtual/template (PAV) KFA yang diinginkan.

Contoh: 92xxxxxx untuk farmasi atau 82xxxxxx untuk alkes.

packaging_code

string

Isi dengan kode kemasan (PAK) KFA yang diinginkan.

Contoh: 94xxxxxx untuk farmasi atau 84xxxxxx untuk alkes.

Response

Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.

2xx Success

Contoh Data

Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.
{
  "total": 66227,
  "page": 1,
  "size": 10,
  "items": {
      "data": [
          {
              "name": "IV Catheter With Vialon Material (VIECARE, Non Injection Port Non Wing / 18 G, 20 G, 22 G, 24 G, 18 G, 20 G, 22 G, 24 G)",
              "kfa_code": "/",
              "active": true,
              "state": "valid",
              "image": null,
              "updated_at": "2023-07-11 08:46:13",
              "farmalkes_type": {
                  "code": "device",
                  "name": "Alat Kesehatan",
                  "group": "alkes"
              },
              "produksi_buatan": "lokal",
              "nie": null,
              "nama_dagang": "VieCare IV Catheter",
              "manufacturer": null,
              "registrar": null,
              "generik": null,
              "rxterm": null,
              "dose_per_unit": 1,
              "fix_price": 8000.0,
              "het_price": null,
              "farmalkes_hscode": null,
              "tayang_lkpp": true,
              "kode_lkpp": null,
              "net_weight": null,
              "net_weight_uom_name": "g",
              "volume": null,
              "volume_uom_name": "mL",
              "uom": {
                  "name": "Units"
              },
              "dosage_form": {
                  "code": false,
                  "name": false
              },
              "product_template": {
                  "kfa_code": "82002082",
                  "name": "IV Catheter With Vialon Material",
                  "state": "valid",
                  "active": true,
                  "display_name": "IV Catheter With Vialon Material",
                  "updated_at": "2023-07-11 08:39:06"
              },
              "active_ingredients": [],
              "replacement": {
                  "product": null,
                  "template": null
              },
              "tags": []
          },
          /*lompat beberapa data*/
          {
              "name": "ECG Monitor (Umum)",
              "kfa_code": "/",
              "active": true,
              "state": "valid",
              "image": null,
              "updated_at": "2023-05-11 05:00:56",
              "farmalkes_type": {
                  "code": "device",
                  "name": "Alat Kesehatan",
                  "group": "alkes"
              },
              "produksi_buatan": "lokal",
              "nie": null,
              "nama_dagang": "MIKI Electrocardiograph CSN-1212A",
              "manufacturer": null,
              "registrar": null,
              "generik": true,
              "rxterm": null,
              "dose_per_unit": 1,
              "fix_price": 40499000.0,
              "het_price": null,
              "farmalkes_hscode": null,
              "tayang_lkpp": true,
              "kode_lkpp": null,
              "net_weight": null,
              "net_weight_uom_name": "g",
              "volume": null,
              "volume_uom_name": "mL",
              "uom": {
                  "name": "Units"
              },
              "dosage_form": {
                  "code": false,
                  "name": false
              },
              "product_template": {
                  "kfa_code": "82000161",
                  "name": "ECG Monitor",
                  "state": "valid",
                  "active": true,
                  "display_name": "ECG Monitor",
                  "updated_at": "2023-08-29 00:49:25"
              },
              "active_ingredients": [],
              "replacement": {
                  "product": null,
                  "template": null
              },
              "tags": []
          }
      ]
  }
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan data dengan format atau ketentuan yang tidak sesuai.

Contoh Data

{
  "detail": [
    {
      "loc": [
        "Ut nisi amet",
        "velit nulla quis minim"
      ],
      "msg": "cupidatat Excepteur enim in",
      "type": "voluptate laborum reprehenderit velit"
    },
    {
      "loc": [
        "id ad",
        "ad"
      ],
      "msg": "cillum",
      "type": "esse sit"
    }
  ]
}

5xx Server Error (Content-Type: text/plain)

Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.

Contoh Data

Gateway Timeout

Contoh Penggunaan/Kode

Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.

cURL (Windows)

curl --insecure --location ^
  --header "Authorization: Bearer <access-token>" ^
  --header "Accept: application/json" ^
  --request GET ^
  "https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products/all?page=1&size=100&product_type=farmasi"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Accept: application/json' \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products/all?page=1&size=100&product_type=farmasi'

Postman

  1. Buat request baru menggunakan New  HTTP Request, atau klik tombol + untuk buat tab request baru.

  2. Masukkan request URL

    https://api-satusehat-stg.dto.kemkes.go.id/kfa-v2/products/all
  3. Lalu pilih request method GET.

  4. Pada tab Auth:

  5. Pada tab Headers:

  6. Pada tab Params, di bagian Query Params:

  7. Klik tombol Send.

  8. Hasil response akan ditampilkan di bagian Response.