API iş akışı kılavuzu

Ne inşa etmek istiyorsunuz?

İşinize en yakın sonucu seçin. Her yol size bir çalışan istek, yanıtın ne içermesi gerektiği, nasıl çalıştığını kontrol edeceğiniz ve bir sonraki yararlı adımı sunar.

Beş pratik yol

Uç nokta listesiyle değil, sonuçla başlayın.

Seçildi: Makro verileri getir

14 günlük API denemeniz

İlk istekten, saklamaya değer bir işe geçin.

Hedef her ürün sayfasını ziyaret etmek değildir. Yararlı, kimliği doğrulanmış API işini tamamlamak, başka bir gün geri dönmek ve tekrarlanabilir bir veri seti veya uygulama iş akışı ile ayrılmaktır.

API ilerlemesini kontrol edin

Gün 0

Erişimi kanıtla

Anahtarı oluşturun, bir kimliği doğrulanmış istek tamamlayın ve ilk yanıtı meta verileriyle birlikte kaydedin.

Adımı aç →

Gün 1-2

İsteği güvenilir hale getirin

Kimlik doğrulama veya filtre sorunlarını çözün ve ilk betiği isimlendirilmiş, tekrarlanabilir bir işe dönüştürün.

Adımı aç →

Günler 3-4

Yayın zamanlaması ekle

Takvimi ikinci bir uç nokta ailesi olarak kullanın ve bir sonraki yararlı API çalışmasını planlayın.

Adımı aç →

Günler 5-7

Araştırma çıktısını oluşturun

Beklentileri veya küçük bir makro serisi grubunu ekleyin, ardından bir kayıtlı karşılaştırma, tablo veya puan tablosu oluşturun.

Adımı aç →

Gün 8-10

Güncellemeleri otomatize edin

Planlanmış REST, SSE veya webhook'ları seçin ve farklı bir günde başka bir başarılı API çalışması tamamlayın.

Adımı aç →

Günler 11-13

İstemciyi güçlendirin

Zaman aşımları, sınırlı denemeler, yanıt doğrulama, kimlik bilgisi güvenli günlükleme ve bayat veri izleme ekleyin.

Adımı aç →

Gün 14

Kanıtları incele

API'nin ekibinizin sürdüreceği tekrarlanabilir bir iş sağladığını onaylayın, ardından bir sonraki veri setini veya uygulama iş akışını seçin.

Adımı aç →

İlk istek

Makro geçmişini getir ve kaydet

Zaten anladığınız bir para birimi ve gösterge ile başlayın. Bu, daha fazla seri eklemeden önce kimlik doğrulama, yanıt şekli, sayfalama ve depolamanın kolayca doğrulanmasını sağlar.

10 dakika Buradan başlayın duyurular

Çalışan örnek

Anahtarınızı şurada tutun FXMD_API_KEY; asla kaynak kontrolüne yapıştırmayın.

import os
import requests

response = requests.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    timeout=20,
)
response.raise_for_status()
payload = response.json()
print(payload["data"][0])

Beklenen sonuç: Güncel EUR enflasyon gözlemlerinin yanı sıra seriyi, kaynağı, sayfalamayı ve veri kalitesini açıklayan yanıt meta verileriyle birlikte bir 200 yanıtı.

İlk betik gerçek bir sistem haline geldiğinde

Sorun giderme ve üretim rehberliği

Bir yanıt başarısız olduğunda, veri döndürmediğinde veya önbelleğe alma, zaman aşımı, yeniden deneme ve olay teslimi gibi üretim kontrollerine ihtiyaç duyulduğunda bu kılavuzları kullanın.

RehberŞu durumlarda kullanınBaşlat
Başarısız veya boş bir yanıtı teşhis edin Anahtarınızı ifşa etmeden ayrı kimlik doğrulama, erişim, yol, hız sınırı ve veri kullanılabilirliği sorunlarını çözün. Kılavuzu aç →
Bir API istemcisini üretime hazır hale getirin Zaman aşımları, sınırlı denemeler, önbelleğe alma, koşullu istekler ve doğru teslimat modelini ekleyin. Kılavuzu aç →