Vejledninger: Godkendelse og API-nøgler
Godkendelse og API-nøgler
Alle forespørgsler til Motorbay API'et kræver en API-nøgle. Der er ikke andet at sætte op: ingen OAuth, ingen tokens at forny.
Send nøglen i én header
curl -H "X-Api-Key: $MOTORBAY_API_KEY" \
"https://api.motorbay.app/v1/dataset"Nøglen skal i headeren X-Api-Key og ingen andre steder. Nøgler accepteres ikke i query-strengen, hvor de ender i logfiler og browserhistorik. En forespørgsel med nøglen i query-strengen og uden headeren får 401 med koden ApiKeyMissing.
Sådan ser en nøgle ud
- Produktionsnøgler begynder med
mbk_live_. Nøgler fra et testmiljø begynder medmbk_test_. - Efter præfikset kommer 43 tegn: bogstaver, tal,
-og_. - I eksempler skriver vi
mbk_test_…eller$MOTORBAY_API_KEY. Indsæt aldrig en rigtig nøgle i et issue, en supportmail eller et skærmbillede.
En nøgle fra det ene miljø virker ikke i det andet.
Opret en nøgle
- Bekræft din e-mail. Du kan ikke oprette en nøgle, før du har gjort det.
- På oversigten vælger du Opret nøgle. Giv den et navn, og en udløbsdato, hvis du vil.
Nøglen vises én gang, når du opretter den. Vi gemmer kun en hash af den, så vi kan ikke vise den igen eller gendanne den. Hvis du mister en nøgle, så opret en ny, og tilbagekald den gamle.
Tilbagekald en nøgle, eller lad den udløbe
Tilbagekald en nøgle på oversigten, når du ikke længere har brug for den, eller hvis den kan være lækket. Forespørgsler med en tilbagekaldt nøgle afvises derefter med 401 og koden ApiKeyInvalid. En nøgle, hvis udløbsdato er passeret, afvises på samme måde.
Sådan skifter du en nøgle uden nedetid: opret en ny nøgle, tag den i brug, og tilbagekald så den gamle.
Hold nøglerne på din server
Kald API'et fra din server, ikke fra en browser eller en mobilapp. Ethvert script på en webside kan læse en nøgle, siden har, og alle kan trække en nøgle ud af en app.
Hvad fejlene betyder
| Status | Kode | Betydning |
|---|---|---|
| 401 | ApiKeyMissing |
Ingen X-Api-Key-header |
| 401 | ApiKeyInvalid |
Nøglen er ukendt, tilbagekaldt, udløbet eller fra det andet miljø |
| 402 | PaymentRequired |
Nøglens betalte abonnement er i en tilstand, vi ikke kan bekræfte |
| 429 | QuotaExceeded |
Nøglens konto har brugt sine forespørgsler for denne måned. På Free kommer de tilbage den 1. |
Se Fejl for hele listen.
Fandt du ikke svaret? Skriv til support@motorbay.app.