Cost+Docs

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 z zastavico -u
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/

Ročno Base64 kodiranje

Če raje sami sestavite glavo, najprej kodirajte ključ:

Kodiranje API ključa
echo -n "YOUR_API_KEY:" | base64

Nato podajte kodirano vrednost v glavi Authorization:

cURL z ročno glavo 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 kodaPomenOpis
200OKZahteva je uspela.
201UstvarjenoVir je bil uspešno ustvarjen.
400Slaba zahtevaZahteva je bila napačna ali manjkajo obvezna polja.
401NepooblaščenoAvtentikacija ni uspela — preverite svoj API ključ.
403PrepovedanoNimate dovoljenja za dostop do tega vira.
404Ni najdenoZahtevani vir ne obstaja.
500Notranja napaka strežnikaNa naši strani je šlo nekaj narobe.
502Slaba prehodNapaka nadrejenega servisa.
503Storitev ni na voljoAPI je začasno nedostopen.
504Časovna omejitev prehodaNadrejeni servis ni odgovoril pravočasno.

On this page