DocsHitelesítés
Ismerje meg, hogyan hitelesítheti magát a Cost+ API-val
A Cost+ API-val való minden kommunikáció TLS 1.2 vagy újabb és HTTP Basic Authentication hitelesítést igényel.
Hogyan működik a Basic Auth
A hitelesítéshez használja az API-kulcsát felhasználónévként üres jelszóval. Base64-kódolja a \{api_key\}: karakterláncot (vegye figyelembe a záró kettőspontot — a jelszó üres).
Az eredményül kapott Authorization fejléc így néz ki:
Authorization: Basic aHVudGVyMjo=Soha ne tegye közzé az API-kulcsát kliensoldali kódban vagy nyilvános tárolókban. Tartsa kizárólag szerveroldalon.
A cURL használata
Beépített támogatás (ajánlott)
A cURL natívan támogatja a Basic Auth-ot a -u kapcsolóval. Adja meg az API-kulcsot, majd egy kettőspontot:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Kézi Base64 kódolás
Ha saját maga szeretné összeállítani a fejlécet, először kódolja a kulcsot:
echo -n "YOUR_API_KEY:" | base64Ezután adja meg a kódolt értéket az Authorization fejlécben:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Az API-kulcs utáni kettőspont kötelező — ez választja el a felhasználónevet az (üres) jelszótól a Basic Auth sémában.
HTTP állapotkódok
Az API szabványos HTTP állapotkódokat használ a kérés eredményének jelzésére.
| Állapotkód | Jelentés | Leírás |
|---|---|---|
| 200 | OK | A kérés sikeres volt. |
| 201 | Létrehozva | Az erőforrás sikeresen létrejött. |
| 400 | Hibás kérés | A kérés hibás volt vagy hiányoznak a kötelező mezők. |
| 401 | Nem hitelesített | A hitelesítés sikertelen — ellenőrizze az API-kulcsát. |
| 403 | Tiltott | Nincs jogosultsága az erőforrás eléréséhez. |
| 404 | Nem található | A kért erőforrás nem létezik. |
| 500 | Belső szerverhiba | Valami hiba történt a mi oldalunkon. |
| 502 | Hibás átjáró | Upstream szolgáltatás hiba. |
| 503 | A szolgáltatás nem elérhető | Az API átmenetileg nem elérhető. |
| 504 | Átjáró időtúllépés | Az upstream szolgáltatás nem válaszolt időben. |