undefined

{level1}.1. Alkes Produk Varian

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-v3/alkes/products

HTTP Verb/Method

POST

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.

Body (application/json)

DATA STRUCTURE:
{
  *page: integer (1)
  *size: integer (2)
  *state: string (3)
  *active: boolean (4)
  *kfa_code: string (5)
  *reference_code: string (6)
  *search: string (7)
  *updated_from_date: string (8)
  *updated_to_date: string (9)
  *farmalkes_type: string (10)
  *category_code: string (11)
  *sub_category_code: string (12)
  *type_code: string (13)
  *sub_type_code: string (14)
}

EXPLANATION:

NoNama ParameterTipe DataKeterangan

1

*page

integer

Isi dengan nomor halaman (page) yang diinginkan.

Contoh: 1.

2

size

integer

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

Contoh: 10.

3

state

string

Isi dengan state varian produk. Terdapat 2 option dalam varian produk draft dan valid

Contoh: valid.

4

active

boolean

Isi true menunjukan data sudah terhapus atau belum

Contoh: true.

5

kfa_code

string

Isi dengan kode kfa

Contoh: 33069659.

6

reference_code

string

Isi dengan kode dari NIE BPOM/LKPP yang ada pada field identifier_ids[].code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'..

Contoh: AKD 21501912107,2649566.

7

search

string

Isi dengan display_name, synonym, atau nama_dagang dalam pencarian fuzzy

Contoh: Surgical Gown.

8

updated_from_date

string

Isi dengan tanggal pencarian 'dari' format YYYY-MM-DD.

Contoh: 2024-05-01.

9

updated_to_date

string

Isi dengan tanggal pencarian 'sampai' format YYYY-MM-DD.

Contoh: 2024-07-30.

10

farmalkes_type

string

Isi dengan tipe kode yang sesuai dengan farmalkes_type.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: device,pkrt.

11

category_code

string

Isi dengan kode level 1 yang sesuai dengan kategori.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 02,03,04.

12

sub_category_code

string

Isi dengan kode level 2 yang sesuai dengan sub_kategori.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 0204,0205.

13

type_code

string

Isi dengan kode level 3 yang sesuai dengan jenis.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 0204001,0204002.

14

sub_type_code

string

Isi dengan kode level 4 yang sesuai dengan jenis.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 0204001003,0204001005.

Contoh Data

{
  "page": 1,
  "size": 10,
  "state": "valid",
  "active": true,
  "kfa_code": "33069659",
  "reference_code": "AKD 21603020231",
  "search": "Surgical Gown",
  "updated_from_date": "2024-05-01",
  "updated_to_date": "2024-07-30",
  "farmalkes_type": "device",
  "category_code": "16",
  "sub_category_code": "1603",
  "type_code": "1603005",
  "sub_type_code": "1603005002"
}

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.
{
  "status": 200,
  "error": false,
  "message": "success",
  "meta": {
      "item_count": 12056,
      "page": {
          "is_cursor": false,
          "current": 1,
          "previous": 0,
          "next": 2,
          "limit": 10,
          "total": 10
      },
      "sort": null,
      "param": null,
      "data": [
          {
              "kfa_code": "33000002",
              "active": true,
              "barcode": "",
              "dapat_dibeli_lkpp": true,
              "discontinued": false,
              "display_name": "Hematology analyzer instrument/unit 3 diff (SYSMEX, XP-100)",
              "farmalkes_type": {
                  "code": "device",
                  "name": "device",
                  "group": "alkes"
              },
              "fix_price": 81082633,
              "fornas": false,
              "identifier_ids": [
                  {
                      "url": null,
                      "code": "33000002",
                      "name": "Hematology Analyzer Instrument/Unit 3 Diff",
                      "use": "official",
                      "end_date": null,
                      "start_date": null,
                      "source_code": "kemkes_ihs",
                      "source_name": "Kamus Farmalkes (KFA – IHS)"
                  },
                  {
                      "url": null,
                      "code": "AKL 20205310017",
                      "name": "SYSMEX XP-100 Automated Hematology Analyzer  and Accessories",
                      "use": "usual",
                      "end_date": "2026-01-28",
                      "start_date": "2020-07-17",
                      "source_code": "nie_regalkes",
                      "source_name": "NIE REGALKES"
                  },
                  {
                      "url": "https://e-katalog.lkpp.go.id/katalog/produk/detail/1370769?lang=id&type=province",
                      "code": "1370769",
                      "name": "Automated Hematology Analyzer XP 100 and Accessories include Peripherals",
                      "use": "usual",
                      "end_date": null,
                      "start_date": "2021-09-14",
                      "source_code": "produk_lkpp",
                      "source_name": "LKPP"
                  }
              ],
              "jenis": {
                  "code": "0205002",
                  "name": "Automated differential cell counter."
              },
              "kategori": {
                  "code": "02",
                  "name": "Peralatan Hematologi dan Patologi"
              },
              "klasifikasi_izin": {
                  "code": "ID",
                  "name": "Invitro Diagnostik",
                  "type": "device"
              },
              "kode_kbki": "4815010999",
              "kode_lkpp": "1370769",
              "manufacturer": "SYSMEX CORPORATION.",
              "manufacturer_country": {
                  "code": "JP",
                  "name": "Japan"
              },
              "med_dev_kelas_risiko": "B",
              "nama_dagang": "SYSMEX XP-100 Automated Hematology Analyzer  and Accessories",
              "nie": "AKL 20205310017",
              "product_template": {
                  "state": "valid",
                  "kfa_code": "32000009",
                  "name": "Hematology analyzer instrument/unit 3 diff",
                  "bmhp": false,
                  "synonyms": "Hematology analyzer 3 diff"
              },
              "produksi_buatan": "import",
              "registrar": "PT. SYSMEX INDONESIA",
              "registrar_country": {
                  "code": "ID",
                  "name": "Indonesia"
              },
              "score_bmp": 0,
              "score_tkdn": 30.29,
              "score_tkdn_bmp": 30.29,
              "stok_wajib_yankes": false,
              "sub_jenis": {
                  "code": "0205002003",
                  "name": "Hematology Analyzer"
              },
              "sub_kategori": {
                  "code": "0205",
                  "name": "Peralatan Hematologi Otomatis dan Semi Otomatis"
              },
              "tayang_lkpp": true,
              "ucum": {
                  "name": "internasional unit",
                  "ci_code": "[IU]",
                  "cs_code": "[IU]"
              },
              "uom_name": "Units",
              "uom_po_name": "Units",
              "updated_at": "2024-05-07T03:41:04.789Z",
              "variant_desc_farmalkes": "<p><br></p>",
              "variant_desc_usage": "<p><br></p>",
              "variant_desc_warning": "<p><br></p>",
              "variant_side_effect": "<p><br></p>",
              "volume": -1,
              "weight": -1,
              "product_state": "valid",
              "replacement": {
                  "product": {
                      "reason": "",
                      "kfa_code": ""
                  },
                  "template": {
                      "reason": "",
                      "kfa_code": ""
                  }
              }
          },
          /* lompat beberapa data */
          {
              "kfa_code": "33000013",
              "active": true,
              "barcode": "",
              "dapat_dibeli_lkpp": false,
              "discontinued": false,
              "display_name": "Hematology analyzer instrument/unit 5 diff (SYSMEX, XN-450)",
              "farmalkes_type": {
                  "code": "device",
                  "name": "device",
                  "group": "alkes"
              },
              "fix_price": 275729556,
              "fornas": false,
              "identifier_ids": [
                  {
                      "url": null,
                      "code": "33000013",
                      "name": "Hematology Analyzer Instrument/Unit 5 Diff",
                      "use": "official",
                      "end_date": null,
                      "start_date": null,
                      "source_code": "kemkes_ihs",
                      "source_name": "Kamus Farmalkes (KFA – IHS)"
                  },
                  {
                      "url": null,
                      "code": "AKL 20205515108",
                      "name": "SYSMEX Automated Hematology Analyzer XN-L Series, ",
                      "use": "usual",
                      "end_date": "2028-01-16",
                      "start_date": "2019-10-07",
                      "source_code": "nie_regalkes",
                      "source_name": "NIE REGALKES"
                  },
                  {
                      "url": "https://e-katalog.lkpp.go.id/katalog/produk/detail/1371585?lang=id&type=province",
                      "code": "1371585",
                      "name": "Automated Hematology Analyser XN-450 License and Accessories include Peripherals",
                      "use": "usual",
                      "end_date": null,
                      "start_date": "2021-09-14",
                      "source_code": "produk_lkpp",
                      "source_name": "LKPP"
                  }
              ],
              "jenis": {
                  "code": "0205002",
                  "name": "Automated differential cell counter."
              },
              "kategori": {
                  "code": "02",
                  "name": "Peralatan Hematologi dan Patologi"
              },
              "klasifikasi_izin": {
                  "code": "ID",
                  "name": "Invitro Diagnostik",
                  "type": "device"
              },
              "kode_kbki": "4815010999",
              "kode_lkpp": "1371585",
              "manufacturer": "SYSMEX CORPORATION.",
              "manufacturer_country": {
                  "code": "JP",
                  "name": "Japan"
              },
              "med_dev_kelas_risiko": "B",
              "nama_dagang": "SYSMEX Automated Hematology Analyzer XN-L Series, XN-450 and Accessories",
              "nie": "AKL 20205515108",
              "product_template": {
                  "state": "valid",
                  "kfa_code": "32000012",
                  "name": "Hematology analyzer instrument/unit 5 diff",
                  "bmhp": false,
                  "synonyms": ""
              },
              "produksi_buatan": "import",
              "registrar": "PT. SYSMEX INDONESIA",
              "registrar_country": {
                  "code": "ID",
                  "name": "Indonesia"
              },
              "score_bmp": 0,
              "score_tkdn": 30.29,
              "score_tkdn_bmp": 30.29,
              "stok_wajib_yankes": false,
              "sub_jenis": {
                  "code": "0205002003",
                  "name": "Hematology Analyzer"
              },
              "sub_kategori": {
                  "code": "0205",
                  "name": "Peralatan Hematologi Otomatis dan Semi Otomatis"
              },
              "tayang_lkpp": true,
              "ucum": {
                  "name": "internasional unit",
                  "ci_code": "[IU]",
                  "cs_code": "[IU]"
              },
              "uom_name": "Units",
              "uom_po_name": "Units",
              "updated_at": "2024-05-07T04:20:23.813Z",
              "variant_desc_farmalkes": "<p><br></p>",
              "variant_desc_usage": "<p><br></p>",
              "variant_desc_warning": "<p><br></p>",
              "variant_side_effect": "<p><br></p>",
              "volume": -1,
              "weight": -1,
              "product_state": "valid",
              "replacement": {
                  "product": {
                      "reason": "",
                      "kfa_code": ""
                  },
                  "template": {
                      "reason": "",
                      "kfa_code": ""
                  }
              }
          }
      ]
  }
}

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 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 --location ^
  --header "Authorization: Bearer {bearer_token}" ^
  --request POST ^
  "https://api-satusehat-stg.dto.kemkes.go.id/kfa-v3/alkes/products"

cURL (Linux)

curl --location \
  --header 'Authorization: Bearer {bearer_token}' \
  --request POST \
  'https://api-satusehat-stg.dto.kemkes.go.id/kfa-v3/alkes/products'

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-v3/alkes/products

  3. Lalu pilih request method POST.

  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. Alkes Produk Template

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-v3/alkes/template

HTTP Verb/Method

POST

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.

Body (application/json)

DATA STRUCTURE:
{
  *page: integer (1)
  *size: integer (2)
  *state: string (3)
  *active: boolean (4)
  *kfa_code: string (5)
  *search: string (6)
  *updated_from_date: string (7)
  *updated_to_date: string (8)
  *farmalkes_type: string (9)
  *category_code: string (10)
  *sub_category_code: string (11)
  *type_code: string (12)
  *sub_type_code: string (13)
}

EXPLANATION:

NoNama ParameterTipe DataKeterangan

1

*page

integer

Isi dengan nomor halaman (page) yang diinginkan.

Contoh: {qs-page}.

2

size

integer

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

Contoh: {qs-size}.

3

state

string

Isi dengan state varian produk. Terdapat 2 option dalam varian produk draft dan valid

Contoh: valid.

4

active

boolean

Isi true menunjukan data sudah terhapus atau belum

Contoh: true.

5

kfa_code

string

Isi dengan kode kfa

Contoh: 33069659.

6

search

string

Isi dengan display_name, synonym, atau nama_dagang dalam pencarian fuzzy

Contoh: Surgical Gown.

7

updated_from_date

string

Isi berdasarkan tanggal awal pencarian yang ingin ditampilkan, dengan format YYYY-MM-DD.

Contoh: 2024-05-01.

8

updated_to_date

string

Isi berdasarkan tanggal akhir pencarian (sampai dengan) yang ingin ditampilkan, dengan format YYYY-MM-DD.

Contoh: 2024-07-30.

9

farmalkes_type

string

Isi dengan tipe kode yang sesuai dengan farmalkes_type.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: device,pkrt.

10

category_code

string

Isi dengan kode level 1 yang sesuai dengan kategori.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 02,03,04.

11

sub_category_code

string

Isi dengan kode level 2 yang sesuai dengan sub_kategori.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 0204,0205.

12

type_code

string

Isi dengan kode level 3 yang sesuai dengan jenis.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 0204001,0204002.

13

sub_type_code

string

Isi dengan kode level 4 yang sesuai dengan jenis.code. Dapat diisi lebih dari satu yang dibatasi dengan 'koma'.

Contoh: 0204001003,0204001005.

Contoh Data

{
  "page": 1,
  "size": 10,
  "state": "valid",
  "active": true,
  "kfa_code": "32004358",
  "search": "acid",
  "updated_from_date": "2024-08-22",
  "updated_to_date": "2024-08-25",
  "farmalkes_type": "device",
  "category_code": "02",
  "sub_category_code": "0204",
  "type_code": "0204001",
  "sub_type_code": "0204001003"
}

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.
{
  "status": 200,
  "error": false,
  "message": "success",
  "meta": {
      "item_count": 11533,
      "page": {
          "is_cursor": false,
          "current": 1,
          "previous": 0,
          "next": 2,
          "limit": 10,
          "total": 10
      },
      "sort": null,
      "param": null,
      "data": [
          {
              "kfa_code": "32000002",
              "active": true,
              "bmhp": true,
              "desc_farmalkes": "<p><br></p>",
              "desc_usage": "<p><br></p>",
              "desc_warning": "<p><br></p>",
              "farmalkes_hscode": "",
              "farmalkes_type": {
                  "code": "device",
                  "name": "device",
                  "group": "alkes"
              },
              "fornas": false,
              "jenis": {
                  "code": "1603005",
                  "name": "Surgical apparel "
              },
              "kategori": {
                  "code": "16",
                  "name": "Peralatan Bedah Umum dan Bedah Plastik"
              },
              "klasifikasi_izin": {
                  "code": "NENS",
                  "name": "Non Elektromedik Non Steril",
                  "type": "device"
              },
              "med_dev_kelas_risiko": "B",
              "name": "Masker anak 3ply earloop",
              "replacement": {
                  "name": "",
                  "reason": "",
                  "kfa_code": ""
              },
              "side_effect": "<p><br></p>",
              "state": "valid",
              "stok_wajib_yankes": false,
              "sub_jenis": {
                  "code": "1603005001",
                  "name": "Surgical Mask"
              },
              "sub_kategori": {
                  "code": "1603",
                  "name": "Peralatan Bedah"
              },
              "synonyms": "",
              "ucum": {
                  "name": "internasional unit",
                  "ci_code": "[IU]",
                  "cs_code": "[IU]"
              },
              "uom_name": "Units",
              "uom_po_name": "Units",
              "updated_at": "2024-10-28T07:12:12.786Z"
          },
          /* lompat beberapa data */
          {
              "kfa_code": "32000012",
              "active": true,
              "bmhp": false,
              "desc_farmalkes": "<p><br></p>",
              "desc_usage": "<p><br></p>",
              "desc_warning": "<p><br></p>",
              "farmalkes_hscode": "",
              "farmalkes_type": {
                  "code": "device",
                  "name": "device",
                  "group": "alkes"
              },
              "fornas": false,
              "jenis": {
                  "code": "0205002",
                  "name": "Automated differential cell counter."
              },
              "kategori": {
                  "code": "02",
                  "name": "Peralatan Hematologi dan Patologi"
              },
              "klasifikasi_izin": {
                  "code": "ID",
                  "name": "Invitro Diagnostik",
                  "type": "device"
              },
              "med_dev_kelas_risiko": "B",
              "name": "Hematology analyzer instrument/unit 5 diff",
              "replacement": {
                  "name": "",
                  "reason": "",
                  "kfa_code": ""
              },
              "side_effect": "<p><br></p>",
              "state": "valid",
              "stok_wajib_yankes": false,
              "sub_jenis": {
                  "code": "0205002003",
                  "name": "Hematology Analyzer"
              },
              "sub_kategori": {
                  "code": "0205",
                  "name": "Peralatan Hematologi Otomatis dan Semi Otomatis"
              },
              "synonyms": "",
              "ucum": {
                  "name": "internasional unit",
                  "ci_code": "[IU]",
                  "cs_code": "[IU]"
              },
              "uom_name": "Units",
              "uom_po_name": "Units",
              "updated_at": "2024-11-05T04:39:45.714Z"
          }
      ]
  }
}

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

{
  "status": 400,
  "error": true,
  "message": "invalid parameter(s)",
  "data": null
}

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 --location ^
  --header "Authorization: Bearer {bearer_token}" ^
  --request POST ^
  "https://api-satusehat-stg.dto.kemkes.go.id/kfa-v3/alkes/template"

cURL (Linux)

curl --location \
  --header 'Authorization: Bearer {bearer_token}' \
  --request POST \
  'https://api-satusehat-stg.dto.kemkes.go.id/kfa-v3/alkes/template'

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-v3/alkes/template

  3. Lalu pilih request method POST.

  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.