panduan aliran kerja API

Apa yang anda ingin bina?

Pilih hasil yang paling hampir dengan tugas anda. Setiap laluan memberi anda satu permintaan kerja, apa yang harus terkandung dalam respons, cara menyemak ia berfungsi, dan langkah berguna seterusnya.

Lima laluan praktikal

Bermula dengan hasil, bukan senarai titik akhir.

Dipilih: Ambil data makro

Percubaan API 14-hari anda

Beralih dari permintaan pertama kepada pekerjaan yang berbaloi untuk dikekalkan.

Matlamatnya bukan untuk melawat setiap halaman produk. Ia adalah untuk melengkapkan kerja API berautentikasi yang berguna, kembali pada hari lain, dan keluar dengan set data atau aliran kerja aplikasi yang boleh diulang.

Semak kemajuan API

Hari 0

Buktikan akses

Cipta kunci, lengkapkan satu permintaan yang diautentikasi, dan simpan respons pertama bersama metadatanya.

Buka langkah →

Hari 1-2

Jadikan permintaan boleh dipercayai

Selesaikan masalah pengesahan atau penapis dan tukar skrip pertama menjadi tugas berulang bernama.

Buka langkah →

Hari 3-4

Tambah masa keluaran

Gunakan kalendar sebagai keluarga titik akhir kedua dan jadualkan larian API berguna seterusnya.

Buka langkah →

Hari 5-7

Bina output penyelidikan

Tambah jangkaan atau kumpulan kecil siri makro, kemudian hasilkan satu perbandingan, jadual, atau skor kad yang disimpan.

Buka langkah →

Hari 8-10

Automatikkan kemas kini

Pilih REST, SSE, atau webhook yang dijadualkan dan lengkapkan satu lagi larian API yang berjaya pada hari yang berbeza.

Buka langkah →

Hari 11-13

Perkukuhkan klien

Tambah timeout, percubaan semula terhad, pengesahan respons, logging selamat-kredensial, dan pemantauan data lapuk.

Buka langkah →

Hari 14

Semak bukti

Sahkan bahawa API membekalkan pekerjaan yang boleh diulang yang akan dikekalkan oleh pasukan anda, kemudian pilih set data atau aliran kerja aplikasi seterusnya.

Buka langkah →

Permintaan pertama

Ambil dan simpan sejarah makro

Mulakan dengan satu mata wang dan penunjuk yang anda sudah fahami. Ini memudahkan pengesahan pengesahan, bentuk respons, pagination, dan storan sebelum anda menambah lebih banyak siri.

10 minit Mula di sini pengumuman

Contoh berfungsi

Kekalkan kunci anda dalam FXMD_API_KEY; jangan sekali-kali tampalkannya ke dalam kawalan sumber.

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])

Hasil yang dijangka: Respons 200 dengan pemerhatian inflasi EUR terkini ditambah dengan metadata respons yang menghuraikan siri, sumber, pagination, dan kualiti data.

Apabila skrip pertama menjadi sistem sebenar

Penyelesaian masalah dan panduan produksi

Gunakan panduan ini apabila respons gagal, tidak mengembalikan data, atau memerlukan kawalan pengeluaran seperti caching, timeout, percubaan semula, dan penghantaran acara.

PanduanGunakan ia apabilaMula
Diagnosis respons yang gagal atau kosong Asingkan masalah pengesahan, akses, laluan, had kadar, dan ketersediaan data tanpa mendedahkan kunci anda. Buka panduan →
Jadikan klien API sedia untuk pengeluaran Tambah timeout, percubaan semula terhad, caching, permintaan bersyarat, dan corak penghantaran yang betul. Buka panduan →