undefined

{level1}.1. Price - Mendapatkan Harga Produk JKN

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/products/farmalkes-price-jkn

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.

*limit

number

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

Contoh: 50.

*kfa_code

string

Isi dengan kode produk KFA yang diinginkan.

Contoh: 93004418.

region_code

string

Isi dengan kode regional JKN yang diinginkan.

  • regional1: Bali, Banten, Jawa Barat, Jawa Timur, Jakarta, Jawa Tengah, Lampung, Yogyakarta

  • regional2: Bangka Belitung, Bengkulu, Jambi, Nusa Tenggara Barat, Riau, Sumatra Barat, Sumatra Selatan, Sumatra Utara

  • regional3: Aceh, Kalimantan Barat, Kalimantan Timur, Kepulauan Riau, Kalimantan Tengah, Sulawesi Utara, Sulawesi Selatan, Sulawesi Tengah

  • regional4: Gorontalo, Kalimantan Tengah, Kalimantan Utara, Sulawesi Tenggara, Sulawesi Barat

  • regional5: Maluku, Maluku Utara, Nusa Tenggara Timur, Papua Barat

  • regional6: Papua Pegunungan, Papua Selatan, Papua Tengah

Contoh: regional1

document_ref

string

Isi dengan dokumen referensi atau dasar hukum yang berlaku.

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": 6,
  "page": 1,
  "limit": 10,
  "items": {
      "data": [
          {
              "product_template_name": "Acarbose 100 mg Tablet",
              "kfa_code": "92000372",
              "document_ref": "HK.01.07/MENKES/1905/2023",
              "active": true,
              "region_name": "Regional 1",
              "region_code": "regional1",
              "start_date": "2023-08-23",
              "end_date": null,
              "price_unit": 848.0,
              "uom_name": "Tablet",
              "updated_at": "2023-08-29 04:11:02",
              "uom_pack": [
                  "Blister",
                  "Strip"
              ],
              "province": [
                  {
                      "province_code": "51",
                      "province_name": "Bali"
                  },
                  {
                      "province_code": "36",
                      "province_name": "Banten"
                  },
                  {
                      "province_code": "32",
                      "province_name": "Jawa Barat"
                  },
                  {
                      "province_code": "35",
                      "province_name": "Jawa Timur"
                  },
                  {
                      "province_code": "31",
                      "province_name": "DKI Jakarta"
                  },
                  {
                      "province_code": "33",
                      "province_name": "Jawa Tengah"
                  },
                  {
                      "province_code": "18",
                      "province_name": "Lampung"
                  },
                  {
                      "province_code": "34",
                      "province_name": "Yogyakarta"
                  }
              ]
          },
          /* lompat beberapa data */
          {
              "product_template_name": "Acarbose 100 mg Tablet",
              "kfa_code": "92000372",
              "document_ref": "HK.01.07/MENKES/1905/2023",
              "active": true,
              "region_name": "Regional 6",
              "region_code": "regional6",
              "start_date": "2023-08-23",
              "end_date": null,
              "price_unit": 1060.0,
              "uom_name": "Tablet",
              "updated_at": "2023-08-29 04:11:02",
              "uom_pack": [
                  "Blister",
                  "Strip"
              ],
              "province": [
                  {
                      "province_code": "95",
                      "province_name": "Papua Pegunungan"
                  },
                  {
                      "province_code": "93",
                      "province_name": "Papua Selatan"
                  },
                  {
                      "province_code": "94",
                      "province_name": "Papua Tengah"
                  }
              ]
          }
      ]
  }
}

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",
        "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/products/farmalkes-price-jkn?{path-code}"

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/products/farmalkes-price-jkn?{path-code}'

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/products/farmalkes-price-jkn
  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 Sesuai ATC 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/products/atc

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: 50.

*atc_code

string

Isi dengan kode Anatomical Therapeutic Chemical (ATC). Kode unik yang ditetapkan untuk obat menurut organ atau sistem tempat obat bekerja dan cara kerjanya. Sistem klasifikasi dikelola oleh Organisasi Kesehatan Dunia (WHO).

  1. Saluran pencernaan (A)

  2. Darah dan organ pembentuk darah (B)

  3. Sistem kardiovaskular (C)

  4. Kulit (D)

  5. Sistem reproduksi (G)

  6. Sistem endokrin (H)

  7. Anti-infeksi untuk penggunaan sistemik (J)

  8. Penyakit ganas dan sistem imun (L)

  9. Otot, tulang, dan sendi (M)

  10. Otak dan sistem saraf (N)

  11. Produk antiparasitik, insektisida, dan repelan (P)

  12. Sistem pernafasan (R)

  13. Organ sensorik (S)

  14. Aneka ragam (V)

referensi: Daftar Kode ATC [atc-code]

Contoh: L.

*level

number

Dalam sistem klasifikasi Anatomical Therapeutic Chemical (ATC), zat aktif dibagi ke dalam kelompok yang berbeda sesuai dengan organ atau sistem tempat mereka bekerja dan sifat terapeutik, farmakologis, dan kimianya. Obat diklasifikasikan dalam kelompok pada lima tingkat yang berbeda.

  1. ATC tingkat 1: Sistem ini memiliki empat belas kelompok anatomis atau farmakologis utama (tingkat 1).

  2. ATC tingkat 2: Subkelompok Farmakologis atau Terapi

  3. ATC tingkat 3 & 4: Subkelompok Kimia, Farmakologi atau Terapi

  4. ATC tingkat 5: Substansi kimia

referensi: Daftar Level ATC [atc-level]

Contoh: 1.

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.
{
  "atc_code": "L",
  "total": 978,
  "page": 1,
  "size": 50,
  "items": {
      "data": [
          {
              "name": "Leuprorelin Acetate 1,88 mg Serbuk Injeksi (TAPROS, VIAL + AMPUL PELARUT)",
              "kfa_code": "/",
              "active": true,
              "state": "draft",
              "image": null,
              "updated_at": "2022-12-16 07:13:01",
              "farmalkes_type": {
                  "code": "medicine",
                  "name": "Obat",
                  "group": "farmasi"
              },
              "produksi_buatan": "import",
              "nie": "DKI0870700244C1",
              "nama_dagang": "TAPROS",
              "manufacturer": "TAKEDA PHARMACEUTICAL COMPANY",
              "registrar": "TAKEDA INDONESIA",
              "generik": null,
              "rxterm": "leuprolide",
              "dose_per_unit": 1,
              "fix_price": 578067.0,
              "het_price": null,
              "farmalkes_hscode": null,
              "tayang_lkpp": true,
              "kode_lkpp": "48347184",
              "net_weight": null,
              "net_weight_uom_name": "g",
              "volume": null,
              "volume_uom_name": "mL",
              "uom": {
                  "name": "Prefilled Syringe"
              },
              "product_template": {
                  "kfa_code": "92000732",
                  "name": "Leuprorelin Acetate 1,88 mg Serbuk Injeksi",
                  "state": "valid",
                  "active": true,
                  "display_name": "Leuprorelin Acetate 1,88 mg Serbuk Injeksi",
                  "updated_at": "2023-08-29 04:33:05"
              },
              "replacement": {
                  "product": null,
                  "template": null
              }
          },
          /*lompat beberapa data*/
          {
              "name": "Epirubicin Hydrochloride 2 mg/mL Larutan Injeksi (SANBE FARMA, 25 mL)",
              "kfa_code": "93000220",
              "active": true,
              "state": "valid",
              "image": null,
              "updated_at": "2023-09-01 03:56:41",
              "farmalkes_type": {
                  "code": "medicine",
                  "name": "Obat",
                  "group": "farmasi"
              },
              "produksi_buatan": "lokal",
              "nie": "GKL1222251043A1",
              "nama_dagang": "EPIRUBICIN HCL",
              "manufacturer": "SANBE FARMA (UNIT IV)",
              "registrar": "SANBE FARMA",
              "generik": true,
              "rxterm": "epirubicin",
              "dose_per_unit": 1,
              "fix_price": null,
              "het_price": 1096360.0,
              "farmalkes_hscode": "30049089",
              "tayang_lkpp": null,
              "kode_lkpp": null,
              "net_weight": null,
              "net_weight_uom_name": "g",
              "volume": 25.0,
              "volume_uom_name": "mL",
              "uom": {
                  "name": "Vial"
              },
              "product_template": {
                  "kfa_code": "92000231",
                  "name": "Epirubicin Hydrochloride 2 mg/mL Larutan Injeksi",
                  "state": "valid",
                  "active": true,
                  "display_name": "Epirubicin Hydrochloride 2 mg/mL Larutan Injeksi",
                  "updated_at": "2023-08-29 00:49:25"
              },
              "replacement": {
                  "product": null,
                  "template": null
              }
          }
      ]
  }
}

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",
        "atc_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/products/atc?page=1&size=50&atc_code=L&level=1"

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/products/atc?page=1&size=50&atc_code=L&level=1'

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/products/atc
  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}.3. Products - Mendapatkan ATC Metadata

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/atc

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: 50.

*tag_code

string

Isi dengan kode tag produk yang diinginkan.

  • ginjal

  • jantung

  • kanker

  • stroke

  • uronefrologi

  • leukemia

Contoh: kanker.

*level

number

Dalam sistem klasifikasi Anatomical Therapeutic Chemical (ATC), zat aktif dibagi ke dalam kelompok yang berbeda sesuai dengan organ atau sistem tempat mereka bekerja dan sifat terapeutik, farmakologis, dan kimianya. Obat diklasifikasikan dalam kelompok pada lima tingkat yang berbeda.

  1. ATC tingkat 1: Sistem ini memiliki empat belas kelompok anatomis atau farmakologis utama (tingkat 1).

  2. ATC tingkat 2: Subkelompok Farmakologis atau Terapi

  3. ATC tingkat 3 & 4: Subkelompok Kimia, Farmakologi atau Terapi

  4. ATC tingkat 5: Substansi kimia

referensi: Daftar Level ATC [atc-level]

Contoh: 1.

*parent_code

string

Isi dengan kode parent produk yang diinginkan.

  1. Saluran pencernaan (A)

  2. Darah dan organ pembentuk darah (B)

  3. Sistem kardiovaskular (C)

  4. Kulit (D)

  5. Sistem reproduksi (G)

  6. Sistem endokrin (H)

  7. Anti-infeksi untuk penggunaan sistemik (J)

  8. Penyakit ganas dan sistem imun (L)

  9. Otot, tulang, dan sendi (M)

  10. Otak dan sistem saraf (N)

  11. Produk antiparasitik, insektisida, dan repelan (P)

  12. Sistem pernafasan (R)

  13. Organ sensorik (S)

  14. Aneka ragam (V)

referensi: Daftar Kode ATC [atc-code]

Contoh: A.

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.
{
  "result": [
      {
          "code": "A",
          "name": "ALIMENTARY TRACT AND METABOLISM",
          "level": "1",
          "schedule_code": "3013",
          "parent": null
      },
      /*lompat beberapa data*/
      {
          "code": false,
          "name": false,
          "level": false,
          "schedule_code": null,
          "parent": null
      }
  ]
}

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/atc?{path-code}"

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/atc?{path-code}'

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/atc
  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}.4. Products - Pencarian Produk Sesuai Tag dengan Paginasi

Unresolved directive in products-tag.adoc - include::{dir-directive}/section-reset.adoc[]

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/products/tag

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: 50.

*tag_code

string

Isi dengan kode tag produk yang diinginkan.

  1. Saluran pencernaan (A)

  2. Darah dan organ pembentuk darah (B)

  3. Sistem kardiovaskular (C)

  4. Kulit (D)

  5. Sistem reproduksi (G)

  6. Sistem endokrin (H)

  7. Anti-infeksi untuk penggunaan sistemik (J)

  8. Penyakit ganas dan sistem imun (L)

  9. Otot, tulang, dan sendi (M)

  10. Otak dan sistem saraf (N)

  11. Produk antiparasitik, insektisida, dan repelan (P)

  12. Sistem pernafasan (R)

  13. Organ sensorik (S)

  14. Aneka ragam (V)

referensi: Daftar Kode ATC [atc-code]

Contoh: {qs-code-tag}.

*level

number

Dalam sistem klasifikasi Anatomical Therapeutic Chemical (ATC), zat aktif dibagi ke dalam kelompok yang berbeda sesuai dengan organ atau sistem tempat mereka bekerja dan sifat terapeutik, farmakologis, dan kimianya. Obat diklasifikasikan dalam kelompok pada lima tingkat yang berbeda.

  1. ATC tingkat 1: Sistem ini memiliki empat belas kelompok anatomis atau farmakologis utama (tingkat 1).

  2. ATC tingkat 2: Subkelompok Farmakologis atau Terapi

  3. ATC tingkat 3 & 4: Subkelompok Kimia, Farmakologi atau Terapi

  4. ATC tingkat 5: Substansi kimia

referensi: Daftar Level ATC [atc-level]

Contoh: kanker.

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.
{
  "tag_code": "kanker",
  "total": 1324,
  "page": 1,
  "size": 50,
  "items": {
      "data": [
          {
              "name": "Foscarnet 24 mg/mL Injeksi (Umum)",
              "kfa_code": "/",
              "active": true,
              "state": "draft",
              "image": null,
              "updated_at": "2023-03-14 13:30:02",
              "farmalkes_type": {
                  "code": "medicine",
                  "name": "Obat",
                  "group": "farmasi"
              },
              "produksi_buatan": null,
              "nie": null,
              "nama_dagang": null,
              "manufacturer": null,
              "registrar": null,
              "generik": null,
              "rxterm": "foscarnet",
              "dose_per_unit": 1,
              "fix_price": 1.0,
              "het_price": null,
              "farmalkes_hscode": null,
              "tayang_lkpp": null,
              "kode_lkpp": null,
              "net_weight": null,
              "net_weight_uom_name": "g",
              "volume": null,
              "volume_uom_name": "mL",
              "uom": {
                  "name": "Botol"
              },
              "product_template": {
                  "kfa_code": "92004216",
                  "name": "Foscarnet 24 mg/mL Injeksi",
                  "state": "valid",
                  "active": true,
                  "display_name": "Foscarnet 24 mg/mL Injeksi",
                  "updated_at": "2023-03-14 13:30:17"
              },
              "replacement": {
                  "product": null,
                  "template": null
              }
          },
          /*lompat beberapa data*/
          {
              "name": "ECG 12 Channel (BTL, Wireless, Trolley + Spiro upgrade)",
              "kfa_code": "83004842",
              "active": true,
              "state": "valid",
              "image": null,
              "updated_at": "2022-11-28 03:14:41",
              "farmalkes_type": {
                  "code": "device",
                  "name": "Alat Kesehatan",
                  "group": "alkes"
              },
              "produksi_buatan": "lokal",
              "nie": "AKD 20502220148",
              "nama_dagang": "BTL-08 MT Plus",
              "manufacturer": "PT. BOLD TECHNOLOGIES LEADING INDONESIA",
              "registrar": "PT. BOLD TECHNOLOGIES LEADING INDONESIA",
              "generik": null,
              "rxterm": null,
              "dose_per_unit": 1,
              "fix_price": 101500000.0,
              "het_price": null,
              "farmalkes_hscode": null,
              "tayang_lkpp": true,
              "kode_lkpp": "1437299",
              "net_weight": null,
              "net_weight_uom_name": "g",
              "volume": null,
              "volume_uom_name": "mL",
              "uom": {
                  "name": "Units"
              },
              "product_template": {
                  "kfa_code": "82000160",
                  "name": "ECG 12 Channel",
                  "state": "valid",
                  "active": true,
                  "display_name": "ECG 12 Channel",
                  "updated_at": "2023-08-29 00:49:25"
              },
              "replacement": {
                  "product": null,
                  "template": null
              }
          }
      ]
  }
}

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 Pengunaan/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/products/tag?{path-code}"

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/products/tag?{path-code}'

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/products/tag
  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}.5. Products - Mendapatkan TAG Metadata

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/tag

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: 50.

*tag_code

string

Isi dengan kode tag produk yang diinginkan.

  • ginjal

  • jantung

  • kanker

  • stroke

  • uronefrologi

  • leukemia

Contoh: kanker.

*level

number

Dalam sistem klasifikasi Anatomical Therapeutic Chemical (ATC), zat aktif dibagi ke dalam kelompok yang berbeda sesuai dengan organ atau sistem tempat mereka bekerja dan sifat terapeutik, farmakologis, dan kimianya. Obat diklasifikasikan dalam kelompok pada lima tingkat yang berbeda.

  1. ATC tingkat 1: Sistem ini memiliki empat belas kelompok anatomis atau farmakologis utama (tingkat 1).

  2. ATC tingkat 2: Subkelompok Farmakologis atau Terapi

  3. ATC tingkat 3 & 4: Subkelompok Kimia, Farmakologi atau Terapi

  4. ATC tingkat 5: Substansi kimia

referensi: Daftar Level ATC [atc-level]

Contoh: 1.

*parent_code

string

Isi dengan kode parent dari produk yang diinginkan.

Contoh: kanker.

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.
{
  "result": [
      {
          "code": "ginjal",
          "name": "Ginjal",
          "level": "1",
          "description": false,
          "parent": null
      },
      /*lompat beberapa data*/
      {
          "code": "leukemia",
          "name": "Leukemia",
          "level": "2",
          "description": false,
          "parent": {
              "code": "kanker",
              "name": "Kanker",
              "level": "1"
          }
      }
  ]
}

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/tag?{path-code}"

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/tag?{path-code}'

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/tag
  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.