API/Felmeddelanden
Kom i gång
Felmeddelanden
EasyFreelance API använder HTTP-statuskoder för att indikera om en begäran lyckades. Statuskoden är det primära kontraktet – formuleringen i meddelandena kan ändras.
- Koder i 2XX-serien betyder att begäran behandlades utan fel.
- Koder i 4XX-serien betyder att begäran misslyckades utifrån informationen som skickades in.
- Koder i 5XX-serien betyder ett fel på EasyFreelances servrar.
Vid 4XX-svar innehåller svaret även information i response body som beskriver orsaken till felet.
Statuskoder
| Kod | Namn | Betydelse |
|---|---|---|
200 | OK | Begäran behandlades. |
201 | Created | Resursen skapades – till exempel utbetalningar, inloggningslänk eller verifieringssession. |
400 | Bad Request | Klientfel eller valideringsfel. Se formaten nedan. |
401 | Unauthorized | Saknad, ogiltig eller utgången token / API-nyckel. |
403 | Forbidden | Resursen finns, men tillhör en annan partner. |
404 | Not Found | Resursen finns inte, eller är inte kopplad till ert partnerkonto. |
422 | Unprocessable Entity | Validering avvisad av ramverket – till exempel en return-URL som inte är godkänd. |
429 | Too Many Requests | Hastighetsbegränsningen på 500 anrop per minut har överskridits. |
5XX | Server Error | Fel hos oss. Försök igen, och kontakta oss om det kvarstår. |
Tre format
Vilket format du får beror på var i stacken felet uppstår. Bygg klienten på statuskoden först, och läs fälten nedan som kompletterande information.
1. Partnerformat: error
De flesta partnerendpoints returnerar ett objekt med nyckeln error. Värdet är antingen en text eller en strukturerad lista.
{
"error": "User not found"
}2. Valideringsfel: error + data
Valideringsfel som uppstår på i övrigt giltiga begäranden är strukturerade lite annorlunda. Dessa returneras med statuskod 400, och svaret innehåller fältnamnen som nycklar i data-objektet.
{
"error": "Validation error",
"data": {
"email": [
"The email has already been taken."
]
}
}3. Ramverksformat: message + errors
Vissa operationer går genom ramverkets egen validator och svarar 422 med message och errors.
{
"message": "The given data was invalid.",
"errors": {
"partner_return_url": [
"The partner return url has already been registered."
]
}
}429 och Retry-After
Hastighetsbegränsningen delas av hela partnerkontot: 500 begäranden per minut över alla /api/v1-rutter. Vid överskridande får du 429, och svaret kan innehålla headern Retry-After med antalet sekunder tills fönstret nollställs.
Polling av verifieringsstatus är den vanligaste källan till 429 hos partners. Polla var 2:e–5:e sekund, sluta när status är terminal, och överväg employee.verified-webhooken i stället för frekvent pollning.
400 från idempotensnycklar
Skickar du headern Idempotency-key, måste värdet vara ett giltigt UUID – annars svarar API:et 400. Är nyckeln redan lagrad för er partner svarar API:et också 400. Se Idempotens.