API/Autentisering
Kom i gang
Autentisering
EasyFreelance API bruker en API-nøkkel og et token for å identifisere og autentisere forespørsler. Begge genereres i Web Panel.
Autentisering skjer med en tokenbasert HTTP Authentication-ordning. For at en forespørsel skal autoriseres må tokenet ligge i Authorization-headeren, prefikset med teksten Bearer og et mellomrom. I tillegg sender du partnerens API-nøkkel i headeren API-key.
Merk at du mottar separate API-nøkler og tokens for produksjonsmiljø og testmiljø. Nøklene fra det ene miljøet virker ikke i det andre.
API-nøkkelen og tokenet gir tilgang til flere funksjoner i systemet, og må derfor oppbevares sikkert. Ikke del dem i offentlig tilgjengelige områder – som GitHub, klient-sidekode eller andre åpne systemer. Trenger du å bytte dem, genererer du nye i Web Panel.
Headere
| Header | Verdi | Beskrivelse | |
|---|---|---|---|
Authorization | Bearer <token> | påkrevd | Personlig access token (Sanctum) fra API-innstillingene. |
API-key | <uuid> | påkrevd | Partnerens API-nøkkel. Samme sted som tokenet. |
Content-Type | application/json | valgfri | Påkrevd når forespørselen har en JSON-body. |
Accept | application/json | valgfri | Anbefalt, slik at feil returneres som JSON og ikke som HTML. |
Idempotency-key | <uuid> | valgfri | Se Idempotens. Anbefalt på POST /payouts. |
Eksempel
Erstatt <token> og <api-nøkkel> med dine egne verdier.
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]"}'
Manglende eller ugyldig autentisering
Mangler headerne, eller er tokenet utløpt eller trukket tilbake, svarer API-et 401 Unauthorized med Laravels standardformat for API-ruter.
{
"message": "Unauthenticated."
}Miljøer
Ratebegrensning
All autentisert trafikk fra samme API-identitet deler én rullerende grense på 500 forespørsler i minuttet på tvers av alle /api/v1-ruter. Overskrides den, svarer API-et 429 Too Many Requests, eventuelt med headeren Retry-After.