API/Autentisering
Kom i gång
Autentisering
EasyFreelance API använder en API-nyckel och en token för att identifiera och autentisera begäranden. Båda genereras i Web Panel.
Autentisering sker med en tokenbaserat HTTP Authentication-system. För att en begäran ska auktoriseras måste token ligga i Authorization-headern, prefixad med texten Bearer och ett mellanslag. Dessutom skickar du partnerns API-nyckel i headern API-key.
Observera att du får separata API-nycklar och tokens för produktionsmiljö och testmiljö. Nycklarna från den ena miljön fungerar inte i den andra.
API-nyckeln och token ger åtkomst till flera funktioner i systemet och måste därför förvaras säkert. Dela dem inte på offentligt tillgängliga platser – som GitHub, klientkod eller andra öppna system. Behöver du byta ut dem genererar du nya i Web Panel.
Headers
| Header | Värde | Beskrivning | |
|---|---|---|---|
Authorization | Bearer <token> | obligatorisk | Personlig access token (Sanctum) från API-inställningarna. |
API-key | <uuid> | obligatorisk | Partnerns API-nyckel. Samma ställe som token. |
Content-Type | application/json | valfri | Obligatorisk när begäran har en JSON-body. |
Accept | application/json | valfri | Rekommenderas, så att fel returneras som JSON och inte som HTML. |
Idempotency-key | <uuid> | valfri | Se Idempotens. Rekommenderas på POST /payouts. |
Exempel
Ersätt <token> och <api-nyckel> med dina egna värden.
curl --location --request POST 'https://test.easyfreelance.no/api/v1/users' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer T8Cf2oWpDhPpYq2uE2JWRHaVdqsC3RJJTsdNSoGMhLxhE1Z3w7L9UVMW4T8owhIF' \ --header 'API-key: fd612e61-de98-4bb7-a636-cfc66bdd61ea' \ --header 'Idempotency-key: 6922d7be-c098-11ec-9d64-0242ac120004' \ --data '{"email":"[email protected]"}'
Saknad eller ogiltig autentisering
Om headerna saknas, eller om token har gått ut eller återkallats, svarar API:et 401 Unauthorized med Laravels standardformat för API-rutter.
{
"message": "Unauthenticated."
}Miljöer
Hastighetsbegränsning
All autentiserad trafik från samma API-identitet delar en gemensam rullande gräns på 500 begäranden per minut över alla /api/v1-rutter. Överskrids den svarar API:et 429 Too Many Requests, eventuellt med headern Retry-After.