Cost+Docs

Autentifikacia

Naucte sa, ako sa autentifikovat s Cost+ API

Vsetka komunikacia s Cost+ API vyzaduje TLS 1.2 alebo vyssie a HTTP Basic autentifikaciu.

Ako funguje Basic Auth

Autentifikujte sa pouzitim vasho API kluca ako mena pouzivatela s prazdnym heslom. Base64 zakodujte retazec \{api_key\}: (vsimnite si konciacu dvojbodku -- heslo je prazdne).

Vysledna hlavicka Authorization vyzera takto:

Authorization: Basic aHVudGVyMjo=

Nikdy nevystavujte svoj API kluc v kode na strane klienta ani vo verejnych repozitaroch. Uchovavajte ho len na strane servera.

Pouzitie cURL

Priamo (odporucane)

cURL nativne podporuje Basic Auth s flagom -u. Zadajte svoj API kluc nasledovany dvojbodkou:

cURL s flagom -u
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/

Manualne Base64 kodovanie

Ak preferujete zostavit hlavicku sami, najprv zakodujte kluc:

Zakodovanie API kluca
echo -n "YOUR_API_KEY:" | base64

Potom zadajte zakodovanu hodnotu v hlavicke Authorization:

cURL s manualnou hlavickou Authorization
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/

Konciaca dvojbodka za API klucom je povinna -- oddeluje meno pouzivatela od (prazdneho) hesla v scheme Basic Auth.

HTTP stavove kody

API pouziva standardne HTTP stavove kody na oznacenie vysledku poziadavky.

Stavovy kodVyznamPopis
200OKPoziadavka bola uspesna.
201VytvoreneZdroj bol uspesne vytvoreny.
400Chybna poziadavkaPoziadavka bola nespravne formatovana alebo chybaju povinne polia.
401NeautorizovaneAutentifikacia zlyhala -- skontrolujte svoj API kluc.
403ZakazaneNemate opravnenie pristupovat k tomuto zdroju.
404NenajdenePozadovany zdroj neexistuje.
500Interna chyba serveraNieco sa pokazilo na nasej strane.
502Chybna branaChyba upstreamovej sluzby.
503Sluzba nedostupnaAPI je docasne nedostupne.
504Casovy limit branyUpstreamova sluzba neodpovedala vcas.

On this page