undefined

{level1}.1. Master Wilayah - Provinsi

Request

URL

https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/provinces?codes

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

*codes

number

Isi dengan kode provinsi berdasarkan kode wilayah dari Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 11, 12.

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

Struktur 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",
  "data": [
      {
          "code": "11",
          "parent_code": "",
          "bps_code": "11",
          "name": "Aceh"
      },
      /* lompat beberapa data */
      {
          "code": "96",
          "parent_code": "",
          "bps_code": "",
          "name": "Papua Barat Daya"
      }
  ]
}

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_code": 400,
  "message": "limit cannot be more than 2000",
  "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 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 --location ^
  --request GET ^
  "https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/provinces?codes"

cURL (Linux)

curl --location \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/provinces?codes'

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/masterdata/v1/provinces?codes

  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. Master Wilayah - Kota/Kabupaten

Request

URL

https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/cities?province_codes

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

*province_codes

number

Isi dengan Kode provinsi berdasarkan Kode Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 11, 12.

codes

number

Isi dengan Kode kabupaten/kota berdasarkan Kode Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 1103,1104, 1210.

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

Struktur 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",
  "data": [
      {
          "code": "1103",
          "parent_code": "11",
          "bps_code": "1105",
          "name": "Kab. Aceh Timur"
      },
      /* lompat beberapa data */
      {
          "code": "1210",
          "parent_code": "12",
          "bps_code": "1207",
          "name": "Kab. Labuhanbatu"
      }
  ]
}

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_code": 400,
  "message": "limit cannot be more than 2000",
  "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 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 --location ^
  --request GET ^
  "https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/cities?province_codes"

cURL (Linux)

curl --location \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/cities?province_codes'

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/masterdata/v1/cities?province_codes

  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. Master Wilayah - Kecamatan

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/masterdata/v1/districts?city_codes

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

*city_codes

number

Isi dengan Kode kabupaten/kota berdasarkan Kode Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 1103, 1104.

codes

number

Isi dengan Kode kecamatan berdasarkan Kode Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 110302, 110301.

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

Struktur 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",
  "data": [
      {
          "code": "110301",
          "parent_code": "1103",
          "bps_code": "1105140",
          "name": "Darul Aman"
      },
      /* lompat beberapa data */
      {
          "code": "110421",
          "parent_code": "1104",
          "bps_code": "1106063",
          "name": "Rusip Antara"
      }
  ]
}

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_code": 400,
  "message": "limit cannot be more than 2000",
  "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 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 --location ^
  --request GET ^
  "https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/districts?city_codes"

cURL (Linux)

curl --location \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/districts?city_codes'

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/masterdata/v1/districts?city_codes

  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. Master Wilayah - Kelurahan/Desa

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/masterdata/v1/sub-districts?district_codes

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

*district_codes

number

Isi dengan Kode kecamatan berdasarkan Kode Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 110301, 110302.

*codes

number

Isi dengan Kode kelurahan/desa berdasarkan Kode Kemendagri. (dapat di-input multi dengan menyertakan koma)

Contoh: 1103012002, 1103012004 ,1103022004.

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

Struktur 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",
  "data": [
      {
          "code": "1103012002",
          "parent_code": "110301",
          "bps_code": "1105140007",
          "name": "Alue Luddin Dua"
      },
      /* lompat beberapa data */
      {
          "code": "1103022035",
          "parent_code": "110302",
          "bps_code": "1105160013",
          "name": "Buket Makmu"
      }
  ]
}

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_code": 400,
  "message": "limit cannot be more than 2000",
  "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 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 --location ^
  --request GET ^
  "https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/sub-districts?district_codes"

cURL (Linux)

curl --location \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/masterdata/v1/sub-districts?district_codes'

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/masterdata/v1/sub-districts?district_codes

  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.