API JSON adalah mekanisme pertukaran data antar sistem menggunakan format berbasis teks JavaScript Object Notation (JSON) melalui protokol HTTP. Format ini menjadi standar industri modern karena strukturnya yang ringan, mudah dibaca manusia, dan didukung secara natif oleh hampir semua bahasa pemrograman saat ini.
Struktur Dasar Format JSON
JSON merepresentasikan data melalui dua struktur utama: objek (kumpulan pasangan kunci dan nilai di dalam kurung kurawal {}) dan array (daftar nilai berurutan di dalam kurung siku []). Nilai data dapat berupa string, angka, boolean, array, objek lain, atau nilai null.
{
"status": "success",
"code": 200,
"message": "Data retrieved successfully",
"data": {
"id": 101,
"nama": "Budi Santoso",
"email": "[email protected]",
"roles": ["admin", "user"],
"aktif": true
}
}
Metode HTTP dalam API JSON
Interaksi dengan API JSON umumnya menggunakan metode standar RESTful HTTP untuk menentukan operasi CRUD (Create, Read, Update, Delete) pada sumber daya server.
| Metode HTTP | Fungsi Utama | Contoh Endpoint | Payload (Body) |
|---|---|---|---|
| GET | Mengambil data dari server | /api/v1/users | Tidak ada |
| POST | Membuat data baru | /api/v1/users | Diperlukan (JSON) |
| PUT | Memperbarui seluruh data | /api/v1/users/101 | Diperlukan (JSON) |
| DELETE | Menghapus data dari server | /api/v1/users/101 | Opsional |
Contoh Implementasi Fetch API (JavaScript)
Berikut adalah contoh kode nyata untuk melakukan permintaan data (request) ke endpoint API JSON dan mengirimkan data baru menggunakan metode POST.
// Mengambil data (GET Request)
fetch('https://api.example.com/v1/users/101', {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer TOKEN_ANDA'
}
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
// Mengirim data baru (POST Request)
fetch('https://api.example.com/v1/users', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
nama: 'Siti Rahma',
email: '[email protected]'
})
})
.then(response => response.json())
.then(result => console.log(result));
Tips Troubleshooting API JSON Lapangan
Kesalahan umum saat mengonsumsi API JSON biasanya bersumber dari kesalahan pengetikan sintaks (missing comma atau unmatched bracket), header Content-Type yang tidak sesuai (harus application/json), atau masalah kebijakan CORS (Cross-Origin Resource Sharing) pada sisi server. Gunakan ekstensi browser seperti JSON Formatter atau alat debugging seperti Postman dan cURL untuk memvalidasi struktur payload sebelum diintegrasikan ke dalam aplikasi produksi.