REST API
REST API adalah API yang dibangun dengan gaya REST (Representational State Transfer): setiap kumpulan data adalah resource dengan URL sendiri, metode HTTP menentukan aksinya, dan server tidak menyimpan state klien di antara request. Gaya ini dijelaskan Roy Fielding dalam disertasi doktoralnya pada tahun 2000.
Rincian request
Request untuk funding rate BTC di semua exchange:
curl "https://api.genesisarbitrage.com/v1/funding/rates?coin=BTC" \
-H "X-API-Key: $GENESIS_API_KEY"
| Bagian | Nilai | Arti |
|---|---|---|
| Metode | GET | Membaca data |
| Base URL | https://api.genesisarbitrage.com/v1 | Server dan versi API |
| Resource | /funding/rates | Funding rate exchange |
| Parameter | coin=BTC | Hanya BTC |
| Header | X-API-Key | Key klien |
Responsnya JSON: data berisi BTC dengan daftar exchange, masing-masing dengan rate per interval funding (funding_pct) dan rate yang dinormalisasi ke 8 jam (funding_8h_pct). Tanpa coin, resource yang sama mengembalikan semua koin. Field dijelaskan di bagian Funding rate.
Metode dan state
Metode memberi tahu server apa yang harus dilakukan pada resource. Semantik metode ditetapkan oleh standar HTTP, RFC 9110:
GET: mengambil data; metode ini aman dan tidak mengubah apa pun di server;POST: mengirim data untuk diproses; Binance memakainya untuk menempatkan order (POST /api/v3/order);PUT: membuat atau mengganti resource;DELETE: menghapus; Binance memakainya untuk membatalkan order (DELETE /api/v3/order).
Genesis API hanya menyajikan data, jadi semua endpoint-nya adalah GET.
Stateless berarti setiap request membawa semua yang dibutuhkan: key, resource, filter. Server tidak mengingat panggilan sebelumnya dan GET tidak mengubah apa pun, sehingga request bisa diulang setelah timeout atau 503: hasilnya hanya bergantung pada request itu sendiri dan data terkini. Agar tidak mengunduh data yang tidak berubah, Genesis API mengirim ETag: request dengan If-None-Match mendapat 304 jika tidak ada yang berubah.
REST vs WebSocket
| REST API | WebSocket | |
|---|---|---|
| Interaksi | Request dan respons | Aliran pesan dua arah |
| Siapa yang memulai | Klien | Salah satu pihak, setelah terhubung |
| Cocok untuk | Snapshot, filter, riwayat | Feed transaksi dan order book |
| Di Genesis API | Setiap endpoint | Tidak ada |
Dengan REST, pembaruan didapat lewat polling: program mengulang request pada interval tertentu. Genesis API memperbarui outputnya setiap meta.freshness_sec detik, dari 60 di Trial sampai 5 di Max, jadi polling lebih sering tidak menambah apa pun.
Lihat juga: endpoint, WebSocket, format respons, pelajaran: request API pertama Anda dengan HTTP, header, dan JSON.
Tanya jawab
Apa bedanya REST API dengan API secara umum?
API adalah seperangkat aturan apa pun yang dipakai program untuk saling berkomunikasi. REST API adalah kasus khusus lewat HTTP: resource di URL, metode standar, dan request yang tidak bergantung pada request sebelumnya.
Dalam format apa REST API merespons?
REST tidak menetapkan format: bisa JSON, XML, atau jenis lain. Genesis API merespons dalam JSON dengan kompresi gzip.