Avtentikacija
Naučite se, kako se avtenticirati s Cost+ API
Vsa komunikacija s Cost+ API zahteva TLS 1.2 ali višje in HTTP Basic avtentikacijo.
Kako deluje Basic Auth
Avtenticirajte se tako, da uporabite svoj API ključ kot uporabniško ime s praznim geslom. Base64-kodirajte niz \{api_key\}: (opomba: dvopičje na koncu — geslo je prazno).
Rezultat glave Authorization izgleda takole:
Authorization: Basic aHVudGVyMjo=Nikoli ne izpostavljajte svojega API ključa v kodi na strani odjemalca ali v javnih repozitorijih. Hranite ga samo na strežniški strani.
Uporaba cURL
Privzeta uporaba (priporočeno)
cURL nativno podpira Basic Auth z zastavico -u. Podajte svoj API ključ, ki mu sledi dvopičje:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Ročno Base64 kodiranje
Če raje sami sestavite glavo, najprej kodirajte ključ:
echo -n "YOUR_API_KEY:" | base64Nato podajte kodirano vrednost v glavi Authorization:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Dvopičje na koncu za API ključem je obvezno — ločuje uporabniško ime od (praznega) gesla v shemi Basic Auth.
Statusne kode HTTP
API uporablja standardne statusne kode HTTP za označevanje rezultata zahteve.
| Statusna koda | Pomen | Opis |
|---|---|---|
| 200 | OK | Zahteva je uspela. |
| 201 | Ustvarjeno | Vir je bil uspešno ustvarjen. |
| 400 | Slaba zahteva | Zahteva je bila napačna ali manjkajo obvezna polja. |
| 401 | Nepooblaščeno | Avtentikacija ni uspela — preverite svoj API ključ. |
| 403 | Prepovedano | Nimate dovoljenja za dostop do tega vira. |
| 404 | Ni najdeno | Zahtevani vir ne obstaja. |
| 500 | Notranja napaka strežnika | Na naši strani je šlo nekaj narobe. |
| 502 | Slaba prehod | Napaka nadrejenega servisa. |
| 503 | Storitev ni na voljo | API je začasno nedostopen. |
| 504 | Časovna omejitev prehoda | Nadrejeni servis ni odgovoril pravočasno. |