API darba plūsmas rokasgrāmata

Ko vēlaties izveidot?

Izvēlieties iznākumu, kas visvairāk atbilst jūsu uzdevumam. Katrs ceļš sniedz vienu darbojošos pieprasījumu, informāciju par to, ko atbildzei jāsatur, kā pārbaudīt darbību un nākamo noderīgo soli.

Pieci praktiski ceļi

Sāciet ar rezultātu, nevis gala punktu sarakstu.

Atlasīts: Iegūt makro datus

Jūsu 14 dienu API izmēģinājums

Pārejiet no pirmā pieprasījuma uz darbu, kas ir vērtīgs saglabāt.

Mērķis nav apmeklēt katru produkta lapu. Tas ir pabeigt noderīgu autentificētu API darbu, atgriezties citā dienā un aiziet ar atkārtojamu datu kopu vai lietotnes darba procesu.

Pārbaudīt API progresu

Diena 0

Pierādīt piekļuvi

Izveidojiet atslēgu, izveidojiet vienu autentificētu pieprasījumu un saglabājiet pirmo atbildi ar tās metadatiem.

Atvērt soli →

Dienas 1-2

Padarīt pieprasījumu uzticamu

Atrisiniet autentifikācijas vai filtra problēmas un pārvērtiet pirmo skriptu par benējamu, nosauktu uzdevumu.

Atvērt soli →

Dienas 3-4

Pievienot izlaides laiku

Izmantojiet kalendāru kā otru gala punktu saime un ieplānojiet nākamo noderīgo API palešanu.

Atvērt soli →

Dienas 5-7

Izveidot pētniecības rezultātu

Pievienojiet cerības vai mazu makro sēriju grupu, pēc tam izveidojiet vienu saglabātu salīdzinājumu, tabulu vai rezultātu lapu.

Atvērt soli →

Dienas 8-10

Automatizēt atjauninājumus

Izvēlieties plānotu REST, SSE vai webhooks un veiciet vēl vienu veiksmīgu API izpildi citā dienā.

Atvērt soli →

Dienas 11-13

Pastiprināt klientu

Pievienojiet taimautus, ierobežotus atkārtojumus, atbildes validēšanu, drošu kredenciālu žurnālveidu un novecojušo datu uzraudzību.

Atvērt soli →

Diena 14

Pārskatīt pierādījumus

Apstipriniet, ka API nodrošina atkārtojamu darbu, ko jūsu komanda saglabās, pēc tam izvēlieties nākamo datu kopumu vai lietošanas darba plūsmu.

Atvērt soli →

Pirmais pieprasījums

Iegūt un saglabāt makro vēsturi

Sāciet ar vienu valūtu un indikatoru, kurus jūs jau saprotat. Tas padara autentifikācijas, atbildes formas, lapošanas un uzglabāšanas pārbaudi vieglāku, pirms pievienojat vairāk sērijām.

10 minūtes Sāciet šeit paziņojumi

Darbojošs piemērs

Sagatavojiet savu atslēgu FXMD_API_KEY; nekad neielīmējiet to avotkontrolē.

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

Gaidītais rezultāts: 200 atbilde ar jaunākajām EUR inflācijas novērojumiem, kā arī atbildes metadati, kas apraksta sēriju, avotu, lapošanu un datu kvalitāti.

Kad pirmais skripts kļūst par īstu sistēmu

Kļūmu novēršana un produkcijas vadība

Izmantojiet šos ceļvežu, ja atbildze neveiksmīga, neatgriež datus vai nepieciešama ražošanas kontrole, piemēram, kešēšana, taimauti, atkārtojumi un notikumu piegāde.

RokasgrāmataIzmantojiet to, kadSākt
Diagnosticēt neveiksmīgu vai tukšu atbildi Atsevišķi risiniet autentifikācijas, piekļuves, ceļa, ātruma ierobežojumu un datu pieejamības problēmas, neatklājot savu atslēgu. Atvērt rokasgrāmatu →
Padarīt API klientu gatavu produkcijai Pievienot taimautus, ierobežotus atkārtojumus, kešēšanu, kondicionālos pieprasījumus un pareizo piegādes shēmu. Atvērt rokasgrāmatu →