Documentatie bekijken
API-referentie
Zoek de oorzaak van een mislukt verzoek en beslis of het te repareren, te wachten of opnieuw te proberen.
Op deze pagina
HTTP-statuscodes
Begin met de HTTP-status, lees dan de foutcode en het bericht voor de specifieke oorzaak.
| Status | Betekenis | Wat je moet doen |
|---|---|---|
| 400 | Ongeldig verzoek | Repareer de bron, vereiste velden, parametertypes of response headers voordat u het opnieuw probeert. |
| 401 | Authenticatie mislukt | Controleer X-API-Key. Een verlopen of ingetrokken sleutel vervangen; dezelfde sleutel opnieuw proberen zal niet helpen. |
| 402 | Onvoldoende kredieten | Controleer het saldo van de rekening. Voeg credits toe of laat de eigenaar van de account de toegang oplossen voordat hij opnieuw wordt ingediend. |
| 403 | Toegang geweigerd | Controleer de bronrechten van de sleutel en de account- of abonnementsstatus. |
| 404 | Niet gevonden | Controleer de URL, de functie ID en het account. Jobs buiten uw toegestane account of bronnen kunnen ook 404 retourneren. |
| 406 | Respons type niet aanvaardbaar | Gebruik Accept: application/json of text/plain. Selecteer Markdown met X-Respond-With: markdown. |
| 409 | Resultaat niet klaar / conflict | Bij een resultaat gelezen, peil de bestaande baan totdat het voltooid. Voor andere eindpunten, los het conflict dat in het lichaam wordt beschreven op. |
| 410 | Resultaat verlopen | Gebruik een opgeslagen kopie. Het resultaat opnieuw proberen URL kan geen verlopen resultaat herstellen. |
| 422 | Ongeldige invoer / mislukte taak | Repareer de gemelde velden. Op een resultaat gelezen, inspecteer job.error: een mislukte taak heeft geen succesvol resultaat om op te halen. |
| 429 | Maximumhoeveelheid | Wacht op Retry-After of retry_after. Verminder de aanvraagsnelheid; wacht voor een volledige wachtrij op bestaande taken tot finish. |
| 500 / 502 / 503 / 504 | Dienst of stroomopwaarts defect | Lees opnieuw met een beperkte back-off. Controleer voor een POST of een timeout van de indiening of het werk is geaccepteerd voordat het opnieuw wordt verzonden. |
Lees een foutmelding
API fouten gebruiken JSON, inclusief wanneer u platte tekst aanvraagt. Het lichaam verschilt per eindpunt. Branch op de HTTP status en code wanneer aanwezig; gebruik bericht of detail om het probleem uit te leggen.
Query fouten zijn vaak fout en bericht; code is optioneel. Authenticatiefouten kunnen success: false gebruiken in plaats van error: true.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}V2 probleemresponsen gebruiken application/problem+json. Houd requestId voor ondersteuning. Validatiefouten kunnen ook fieldErrors met veld, code en bericht omvatten.
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}Status, headers en body inspecteren
Gebruik curl --include om alle drie te zien. Dit voorbeeld controleert uw sleutel met een gratis account gelezen; het niet indienen van een query. Stel eerst FLASHDATA_API_KEY in in uw omgeving.
curl --include --silent --show-error --max-time 20 \
'https://api.flashdata.dev/v2/api-access/identity' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'Wanneer opnieuw proberen
Een herhaalde POST kan een andere factureerbare query maken. Een timeout van het netwerk bewijst niet dat het eerste verzoek werd afgewezen. Bewaar de taak ID zodra u deze ontvangt.
| Situatie | Volgende actie |
|---|---|
| Ongeldige invoer, sleutel, toestemming of balans | Stop. Repareer de status van het verzoek of de rekening voordat u het opnieuw probeert; loop deze fouten niet door. |
| 429 met een wacht hint | Eer Retry-After (seconden of HTTP-datum), of de JSON retry_after-waarde in seconden. Als beide aanwezig zijn, gebruik dan de langere vertraging. |
| Lees verzoek: 429 / tijdelijke 5xx / netwerkfout | Probeer dezelfde GET opnieuw. Zonder een wacht hint, gebruik toenemende vertragingen met jitter, een maximum aantal pogingen en een tijdslimiet. |
| POST timeout of dubbelzinnig 5xx | Houd de bestaande baan ID en controleer de status ervan. Als er geen ID is ontvangen, inspecteer dan de taakgeschiedenis voordat u besluit om opnieuw in te dienen. |
Een achtergrondtaak controleren
HTTP 200 van het status-eindpunt betekent dat de lezing geslaagd is. Controleer job.status om te weten of de taak geslaagd is. Stel JOB_ID in op uw bestaande taak; dit commando biedt geen vervanging aan.
| job.status | Wat je moet doen |
|---|---|
| pending / processing | Wacht, kijk dan naar dezelfde baan. Een resultaat lees geeft 409 terug tot voltooiing. |
| completed | Ophalen en opslaan van het resultaat. Originele JSON resultaten geven een 302 opslagredirect terug; geformatteerde resultaten geven een lichaam direct terug. |
| failed | Stop met peilen en inspecteer job.error. Het resultaat endpoint geeft 422 terug met code result_not_ready voor een mislukte taak. |
curl --fail-with-body --silent --show-error --max-time 30 \
"https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'Response-format fouten
| Status / code | Repareren |
|---|---|
| 400 · unsupported_representation | Stel X-Respond-With in op markdown of verwijder de header. |
| 406 · not_acceptable | Stel Accept in op application/json of text/plain; gebruik UTF-8 als u een tekenset opgeeft. |
Vraag hulp bij een verzoek
Stuur het eindpunt, UTC tijdstempel, HTTP status, foutcode en verzoek of taak ID. Verwijder API sleutels, tokens en ondertekend URLs uit het rapport.