REST API
REST API, REST tarzında (Representational State Transfer) kurulmuş bir API'dir: her veri seti kendi URL'sine sahip bir kaynaktır, eylemi HTTP yöntemi belirler ve sunucu istekler arasında istemci durumunu tutmaz. Bu tarzı Roy Fielding 2000 yılındaki doktora tezinde tanımlamıştır.
İsteğin dökümü
Tüm borsalardaki BTC fonlama oranları için bir istek:
curl "https://api.genesisarbitrage.com/v1/funding/rates?coin=BTC" \
-H "X-API-Key: $GENESIS_API_KEY"
| Bölüm | Değer | Anlamı |
|---|---|---|
| Yöntem | GET | Veriyi okumak |
| Temel URL | https://api.genesisarbitrage.com/v1 | Sunucu ve API sürümü |
| Kaynak | /funding/rates | Borsaların fonlama oranları |
| Parametre | coin=BTC | Yalnızca BTC |
| Başlık | X-API-Key | İstemci anahtarı |
Yanıt JSON'dur: data içinde BTC ve borsa listesi bulunur; her borsa için fonlama aralığına göre oran (funding_pct) ile 8 saate normalleştirilmiş oran (funding_8h_pct) verilir. coin olmadan aynı kaynak tüm coin'leri döndürür. Alanlar Fonlama oranları bölümünde açıklanmıştır.
Yöntemler ve durum
Yöntem, sunucuya kaynakla ne yapacağını söyler. Yöntemlerin anlamı HTTP standardı RFC 9110 ile belirlenir:
GET: veri almak; yöntem güvenlidir ve sunucuda hiçbir şeyi değiştirmez;POST: işlenmek üzere veri göndermek; Binance emir vermek için kullanır (POST /api/v3/order);PUT: kaynak oluşturmak veya değiştirmek;DELETE: silmek; Binance emri iptal etmek için kullanır (DELETE /api/v3/order).
Genesis API yalnızca veri sunduğu için tüm endpoint'leri GET'tir.
Durumsuz (stateless), her isteğin ihtiyaç duyduğu her şeyi taşıması demektir: anahtar, kaynak, filtreler. Sunucu önceki çağrıları hatırlamaz ve GET hiçbir şeyi değiştirmez; bu yüzden zaman aşımından ya da 503'ten sonra istek tekrarlanabilir: sonuç yalnızca isteğe ve güncel veriye bağlıdır. Değişmeyen veriyi yeniden indirmemek için Genesis API bir ETag gönderir: If-None-Match içeren istek, bir şey değişmediyse 304 alır.
REST ve WebSocket
| REST API | WebSocket | |
|---|---|---|
| Etkileşim | İstek ve yanıt | Her iki yönde mesaj akışı |
| Kim başlatır | İstemci | Bağlantıdan sonra iki taraf da |
| Uygun olduğu iş | Anlık görüntüler, filtreler, geçmiş | İşlem ve emir defteri akışları |
| Genesis API'de | Her endpoint | Yok |
REST'te güncellemeleri polling ile alırsınız: program isteği belirli aralıkla tekrarlar. Genesis API çıktısını her meta.freshness_sec saniyede bir yeniler; bu süre Trial'da 60, Max'te 5 saniyedir, dolayısıyla daha sık sorgulamak bir şey kazandırmaz.
Ayrıca bakın: endpoint, WebSocket, yanıt formatı, ders: HTTP, başlıklar ve JSON ile ilk API isteğiniz.
Sorular ve cevaplar
REST API genel anlamda API'den nasıl farklıdır?
API, programların birbirleriyle konuşmak için kullandığı her türlü kurallar bütünüdür. REST API, HTTP üzerindeki özel bir durumdur: URL'lerde kaynaklar, standart yöntemler ve önceki isteklere bağlı olmayan istekler.
REST API hangi formatta yanıt verir?
REST bir format dayatmaz: JSON, XML veya başka bir tür olabilir. Genesis API, gzip sıkıştırmasıyla JSON olarak yanıt verir.