Working with JSON APIs: A Beginner's Guide — csv-x.com

Saya masih ingat hari ketika saya secara tidak sengaja merusak seluruh jalur data perusahaan kami. Itu tahun 2015, saya sudah tiga bulan bekerja sebagai pengembang junior di sebuah startup fintech, dan saya baru saja mendorong kode yang membuat 50.000 permintaan API dalam waktu kurang dari dua menit. Batas kuota kami adalah 1.000 per jam. Panggilan telepon dari penyedia API kami tidak menyenangkan, dan percakapan dengan CTO saya juga tidak lebih baik. Momen memalukan itu mengajarkan saya lebih banyak tentang bekerja dengan API JSON daripada tutorial mana pun yang bisa, dan itulah alasan saya menulis panduan ini hari ini—agar Anda bisa belajar dari kesalahan saya daripada membuat kesalahan Anda sendiri.

Selama sembilan tahun terakhir sebagai insinyur backend dan spesialis integrasi API, saya telah bekerja dengan ratusan API JSON yang berbeda—dari layanan cuaca sederhana hingga penyedia data keuangan yang kompleks. Saya telah membangun sistem yang memproses jutaan panggilan API setiap hari, dan saya telah memecahkan masalah integrasi yang membuat perusahaan merugi ribuan dolar per jam downtime. Apa yang saya pelajari adalah bahwa bekerja dengan API JSON bukan hanya tentang membuat permintaan HTTP dan memparsing respons. Ini tentang memahami batas kuota, menangani kesalahan dengan baik, mengelola otentikasi dengan aman, dan membangun sistem yang tahan banting yang tidak hancur saat terjadi kesalahan.

Panduan ini akan membawa Anda melalui semua yang perlu Anda ketahui untuk bekerja dengan percaya diri dengan API JSON, baik Anda sedang membangun integrasi pertama Anda atau ingin meningkatkan keterampilan Anda. Kita akan membahas dasar-dasar, menjelajahi jebakan umum, dan menyelami teknik praktis yang akan membuat Anda menjadi pengembang yang lebih efektif.

Memahami Apa Itu API JSON

Sebelum kita menyelami rincian teknis, mari kita tetapkan apa yang sebenarnya kita bicarakan. API JSON adalah cara bagi aplikasi perangkat lunak yang berbeda untuk berkomunikasi satu sama lain melalui internet menggunakan JSON (JavaScript Object Notation) sebagai format data. Anggaplah itu seperti pelayan di restoran—Anda (klien) membuat permintaan untuk sesuatu yang spesifik, pelayan membawa permintaan itu ke dapur (server), dan membawa kembali apa yang Anda minta dalam format standar.

JSON telah menjadi format dominan untuk API web karena ringan, mudah dibaca manusia, dan didukung oleh hampir semua bahasa pemrograman. Ketika saya memulai karir saya, XML masih umum, dan biarkan saya memberi tahu Anda—bekerja dengan JSON jauh lebih menyenangkan. Respons JSON yang tipikal mungkin terlihat seperti ini:

{"user": {"id": 12345, "name": "Sarah Chen", "email": "[email protected]", "created_at": "2024-01-15T10:30:00Z"}}

Bandingkan itu dengan versi XML-nya dengan semua tag pembuka dan penutupnya, dan Anda akan mengerti mengapa JSON menang. Ini ringkas, mudah dibaca, dan secara alami terhubung dengan struktur data di sebagian besar bahasa pemrograman—objek di JavaScript, kamus di Python, peta di Go, dan seterusnya.

Sebagian besar API JSON modern mengikuti prinsip REST (Representational State Transfer), yang berarti mereka menggunakan metode HTTP standar seperti GET (mengambil data), POST (membuat data), PUT atau PATCH (memperbarui data), dan DELETE (menghapus data). Standardisasi ini membuat API dapat diprediksi dan lebih mudah untuk dikerjakan. Ketika Anda melihat permintaan GET ke /api/users/12345, Anda bisa mengasumsikan bahwa itu mengambil informasi tentang pengguna 12345. POST ke /api/users mungkin sedang membuat pengguna baru.

Memahami dasar ini sangat penting karena ini membentuk bagaimana Anda akan berinteraksi dengan hampir setiap API yang Anda temui. Polanya konsisten di berbagai layanan, yang berarti setelah Anda menguasai dasar-dasar dengan satu API, Anda dapat menerapkan pengetahuan itu ke ratusan API lainnya.

Membuat Permintaan API Pertama Anda

Mari kita praktis. Cara paling sederhana untuk berinteraksi dengan API JSON adalah melalui alat seperti curl atau Postman, tetapi pada akhirnya Anda ingin membuat permintaan dari kode Anda. Saya akan menunjukkan contoh dalam Python karena mudah diakses, tetapi konsepnya berlaku untuk bahasa apa pun.

Berikut adalah permintaan API paling dasar yang dapat Anda buat:

import requests
response = requests.get('https://api.example.com/users/12345')
data = response.json()
print(data['name'])

Cuplikan empat baris ini melakukan banyak hal: mengirim permintaan HTTP GET ke API, menerima respons, memparsing JSON menjadi kamus Python, dan mengekstrak bidang tertentu. Sederhana, kan? Tetapi kode ini memiliki setidaknya lima masalah serius yang akan membuatnya gagal di produksi.

Pertama, tidak ada penanganan kesalahan. Apa yang terjadi jika jaringan down? Apa yang terjadi jika pengguna tidak ada dan API mengembalikan 404? Apa yang terjadi jika API tidak tersedia sementara dan mengembalikan 503? Kode Anda akan crash. Kedua, tidak ada batas waktu yang ditentukan. Jika server API hang, kode Anda akan menunggu tanpa batas. Ketiga, tidak ada otentikasi—sebagian besar API nyata memerlukan beberapa bentuk kredensial. Keempat, tidak ada pertimbangan pembatasan kuota. Dan kelima, tidak ada validasi bahwa respons sebenarnya berisi data yang Anda harapkan.

Berikut versi yang lebih robust yang mengatasi masalah ini:

import requests
from requests.exceptions import RequestException
import time

def fetch_user(user_id, api_key, max_retries=3):
    url = f'https://api.example.com/users/{user_id}'
    headers = {'Authorization': f'Bearer {api_key}'}
    
    for attempt in range(max_retries):
        try:
            response = requests.get(url, headers=headers, timeout=10)
            response.raise_for_status()
            data = response.json()
            
            if 'name' not in data:
                raise ValueError('Format respons tidak valid')
            
            return data
        
        except RequestException as e:
            if attempt == max_retries - 1:
                raise
            time.sleep(2 attempt)
    
    return None