Penulis: Irvan Gunawan
API adalah antarmuka yang menyediakan cara bagi perangkat lunak untuk berinteraksi. Dalam artikel ini, fokusnya API berbasis HTTP: aplikasi mengirim permintaan ke server, lalu membaca balasannya. API tidak selalu berbentuk website yang dilihat manusia.
Definisi API di MDN memakai istilah Application Programming Interface. Untuk mulai memahami alurnya, bayangkan aplikasi latihan yang menampilkan informasi barang.
Request: aplikasi meminta sesuatu
Aplikasi ingin membaca barang bernomor 17. Pada contoh fiktif ini, dokumentasi layanan menetapkan operasi GET /barang/17. GET adalah metode permintaan, sedangkan path menunjuk sumber yang diminta. Ini pola latihan, bukan alamat layanan yang bisa langsung dicoba.
Endpoint adalah titik akses API yang dituju. Saat membaca dokumentasi, perhatikan alamat server, path, metode, parameter, serta kebutuhan autentikasinya. Path saja belum menjelaskan seluruh kontrak layanan.
Panduan client-server MDN menjelaskan bahwa request HTTP membawa informasi seperti URL dan metode, lalu server mengirim response. Aplikasi pengirim disebut client; tidak harus browser.
Response: baca status dan isinya
Misalnya server mengembalikan status 200 dengan data JSON berikut. JSON adalah format pertukaran data; isi di bawah sengaja dibuat untuk latihan.
{
"id": 17,
"nama": "Keyboard",
"stok": 8
}
Angka 8 bukan hasil pemeriksaan stok bisnis mana pun. Aplikasi harus mengetahui arti field tersebut dari dokumentasi API, termasuk kapan datanya diperbarui. Balasan teknis yang berhasil tidak otomatis menjawab seluruh kebutuhan bisnis.
Kalau gagal, jangan hanya melihat pesan di layar
- 200: request berhasil; arti hasil tetap mengikuti metode dan isi response.
- 401: request membutuhkan kredensial autentikasi yang valid.
- 403: server menolak memenuhi request; cek izin akses.
- 404: sumber yang diminta tidak ditemukan. Pada API, alamat endpoint bisa valid tetapi ID barangnya tidak ada.
Rincian tersebut tersedia pada referensi status HTTP MDN. Saat melapor, catat metode, path, status, dan waktu kejadian. Jangan menyalin token atau password ke screenshot maupun forum publik.
Checklist membaca dokumentasi API
Cari contoh request, bentuk response, cara autentikasi, batas pemakaian, dan penjelasan error. Mulai dari operasi baca pada layanan latihan yang memang mengizinkannya. Jangan mencoba operasi tulis atau hapus pada data asli hanya karena contoh tutorial memakai metode tersebut.
How useful was this post?
Click on a star to rate it!
Average rating / 5. Vote count:
No votes so far! Be the first to rate this post.