Endpoint API OpenDOSM

GET https://api.data.gov.my/opendosm

Apa yang API OpenDOSM boleh lakukan?

API OpenDOSM direka untuk membolehkan pengguna mengakses katalog data OpenDOSM secara berprogram. API ini disesuaikan untuk pengguna yang hanya berminat dalam data OpenDOSM. Untuk data yang lebih umum di seluruh data.gov.my, sila rujuk keData Catalogue API.

Bagaimana untuk Mencari Sumber yang Tersedia

Untuk mengakses katalog data tertentu, anda perlu menentukan parameter id dalam URL permintaan anda. Ini adalah parameter yang wajib, berikut adalah contoh bagaimana menggunakannya:

GET https://api.data.gov.my/opendosm?id=cpi_core

Untuk menemui sumber-sumber yang tersedia, sila lawati OpenDOSM Data Catalogue page (opens in a new tab). Terdapat bahagian di bahagian bawah yang bertajuk "Sample OpenAPI query" yang mengandungi id yang diperlukan untuk setiap katalog data. Jika satu katalog data tidak tersedia melalui API, ia akan dinyatakan secara jelas.

Format Permintaan & Respons

Untuk menapis dan meminta data, gunakan operasi penapisan standard dalam API. Request Query. Anda boleh mencari maklumat mengenai lajur yang boleh di-filter dalam bahagian Metadata di bawah setiap halaman Katalog Data. Untuk maklumat mengenai bagaimana API bertindak balas terhadap permintaan anda, rujuk kepada Response Format.

Contoh Permintaan

Mari kita lihat contoh penggunaan sumber cpi_core:

1. Cari sumber tersebut

Pergi ke halaman Katalog Data dan cari sumber data Core CPI Overall dataset (opens in a new tab). Anda akan menemui nilai id, "cpi_core," dalam bahagian "Contoh Pertanyaan OpenAPI" di bahagian bawah halaman. Kami akan menggunakan id ini sebagai contoh kami.

2. Menghantar Permintaan API

Untuk mengambil data dari API, gunakan perintah curl berikut. Buka terminal anda dan masukkan perintah ini:

curl --location 'http://api.data.gov.my/opendosm?id=cpi_core&limit=3'

Melaksanakan perintah ini akan menghantar permintaan kepada API, dengan sasaran dataset cpi_core, dan mengehadkan respons kepada 3 rekod pertama. Untuk lebih banyak penapis yang tersedia, sila rujuk kepada Request Query.

3. Memahami Respons

Untuk memahami respons API, Anda dapat merujuk kepada Response Format. Ini memberikan penjelasan terperinci tentang apa yang dimaksud dengan respons API. Dalam contoh ini, panjang total daftar ini akan menjadi 3, sesuai dengan parameter limit yang ditentukan.