Lompati ke konten

Panduan alur kerja API

Apa yang ingin Anda bangun?

Pilih hasil yang paling dekat dengan pekerjaan Anda. Setiap path memberi Anda satu permintaan yang berfungsi, apa yang harus ada dalam respons, cara memeriksa apakah itu berhasil, dan langkah berguna berikutnya.

Lima jalur praktis

Mulailah dengan hasilnya, bukan daftar endpoint.

Selected: Harden a client

Uji coba API 14 hari Anda

Berpindah dari permintaan pertama ke pekerjaan yang layak dipertahankan.

Tujuannya bukan untuk mengunjungi setiap halaman produk. Tujuannya adalah untuk menyelesaikan pekerjaan API terautentikasi yang berguna, kembali di hari lain, dan pergi dengan dataset atau alur kerja aplikasi yang dapat diulang.

Periksa kemajuan API

Hari 0

Buktikan akses

Buat kunci, selesaikan satu permintaan terautentikasi, dan simpan respons pertama beserta metadatanya.

Buka langkah →

Hari 1-2

Buat permintaan menjadi andal

Selesaikan masalah autentikasi atau filter dan ubah skrip pertama menjadi pekerjaan bernama yang dapat diulang.

Buka langkah →

Hari 3-4

Tambahkan waktu rilis

Gunakan kalender sebagai keluarga endpoint kedua dan jadwalkan run API berguna berikutnya.

Buka langkah →

Hari 5-7

Bangun output penelitian

Tambahkan ekspektasi atau sekelompok kecil seri makro, lalu hasilkan satu perbandingan, tabel, atau kartu skor yang disimpan.

Buka langkah →

Hari 8-10

Otomatiskan pembaruan

Pilih REST, SSE, atau webhook terjadwal dan selesaikan API run yang berhasil lainnya pada hari yang berbeda.

Buka langkah →

Hari 11-13

Perkuat klien

Tambahkan timeout, upaya pengulangan terbatas, validasi respons, logging yang aman untuk kredensial, dan pemantauan data usang.

Buka langkah →

Hari 14

Tinjau bukti

Konfirmasikan bahwa API menyediakan pekerjaan berulang yang akan dipertahankan tim Anda, lalu pilih dataset atau alur kerja aplikasi berikutnya.

Buka langkah →

Production readiness

Buat klien API siap produksi

Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.

25 minutes Production pattern pengumumanchangesstreamwebhooks

Contoh kerja

Simpan kunci Anda di FXMD_API_KEY; jangan pernah menempelkannya ke dalam kontrol sumber.

import os
import requests
from urllib3.util.retry import Retry

session = requests.Session()
retry = Retry(total=3, backoff_factor=0.5, status_forcelist=(429, 502, 503, 504))
session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))

response = session.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    headers={"Accept-Encoding": "gzip"},
    timeout=(3.05, 20),
)
response.raise_for_status()

Hasil yang diharapkan: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

Ketika skrip pertama menjadi sistem nyata

Pemecahan masalah dan panduan produksi

Gunakan panduan ini jika respons gagal, tidak mengembalikan data, atau memerlukan kontrol produksi seperti caching, timeout, retry, dan pengiriman event.

PanduanGunakan saatMulai
Diagnosis respons yang gagal atau kosong Masalah autentikasi, akses, jalur, batas-kecepatan, dan ketersediaan data yang terpisah tanpa mengekspos kunci Anda. Buka panduan →
Buat klien API siap produksi Tambahkan timeout, retries terbatas, caching, permintaan kondisional, dan pola pengiriman yang tepat. Buka panduan →