DocsAutentisering
Lär dig hur du autentiserar mot Cost+ API:et
All kommunikation med Cost+ API:et kräver TLS 1.2 eller högre och HTTP Basic Authentication.
Hur Basic Auth fungerar
Autentisera genom att använda din API-nyckel som användarnamn med ett tomt lösenord. Base64-koda strängen \{api_key\}: (notera det avslutande kolonet — lösenordet är tomt).
Den resulterande Authorization-headern ser ut så här:
Authorization: Basic aHVudGVyMjo=Exponera aldrig din API-nyckel i klientkod eller publika repositoryn. Håll den enbart på serversidan.
Använda cURL
Direkt (rekommenderat)
cURL stöder Basic Auth nativt med flaggan -u. Ange din API-nyckel följt av ett kolon:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Manuell Base64-kodning
Om du föredrar att konstruera headern själv, koda först nyckeln:
echo -n "YOUR_API_KEY:" | base64Ange sedan det kodade värdet i Authorization-headern:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Det avslutande kolonet efter API-nyckeln krävs — det separerar användarnamnet från det (tomma) lösenordet i Basic Auth-schemat.
HTTP-statuskoder
API:et använder standard HTTP-statuskoder för att indikera resultatet av en förfrågan.
| Statuskod | Betydelse | Beskrivning |
|---|---|---|
| 200 | OK | Förfrågan lyckades. |
| 201 | Skapad | Resursen skapades framgångsrikt. |
| 400 | Felaktig förfrågan | Förfrågan var felformaterad eller saknade obligatoriska fält. |
| 401 | Ej auktoriserad | Autentiseringen misslyckades — kontrollera din API-nyckel. |
| 403 | Förbjuden | Du har inte behörighet att komma åt denna resurs. |
| 404 | Hittades inte | Den begärda resursen finns inte. |
| 500 | Internt serverfel | Något gick fel på vår sida. |
| 502 | Bad Gateway | Fel i uppströms-tjänsten. |
| 503 | Tjänsten ej tillgänglig | API:et är tillfälligt otillgängligt. |
| 504 | Gateway Timeout | Uppströms-tjänsten svarade inte i tid. |