DocsAutentizace
Zjistěte, jak se autentizovat vůči API Cost+
Veškerá komunikace s API Cost+ vyžaduje TLS 1.2 nebo vyšší a HTTP Basic Authentication.
Jak funguje Basic Auth
Autentizujte se použitím svého API klíče jako uživatelského jména s prázdným heslem. Zakódujte řetězec \{api_key\}: do Base64 (všimněte si koncové dvojtečky — heslo je prázdné).
Výsledná hlavička Authorization vypadá takto:
Authorization: Basic aHVudGVyMjo=Nikdy nevystavujte svůj API klíč v klientském kódu ani ve veřejných repozitářích. Uchovávejte ho pouze na straně serveru.
Použití cURL
Vestavěná podpora (doporučeno)
cURL nativně podporuje Basic Auth pomocí přepínače -u. Předejte svůj API klíč následovaný dvojtečkou:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Ruční Base64 kódování
Pokud chcete hlavičku sestavit ručně, nejprve zakódujte klíč:
echo -n "YOUR_API_KEY:" | base64Poté předejte zakódovanou hodnotu v hlavičce Authorization:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Koncová dvojtečka za API klíčem je povinná — odděluje uživatelské jméno od (prázdného) hesla ve schématu Basic Auth.
HTTP stavové kódy
API používá standardní HTTP stavové kódy k indikaci výsledku požadavku.
| Stavový kód | Význam | Popis |
|---|---|---|
| 200 | OK | Požadavek byl úspěšný. |
| 201 | Created | Zdroj byl úspěšně vytvořen. |
| 400 | Bad Request | Požadavek byl chybně formátován nebo chybí povinná pole. |
| 401 | Unauthorized | Autentizace selhala — zkontrolujte svůj API klíč. |
| 403 | Forbidden | Nemáte oprávnění k přístupu k tomuto zdroji. |
| 404 | Not Found | Požadovaný zdroj neexistuje. |
| 500 | Internal Server Error | Něco se pokazilo na naší straně. |
| 502 | Bad Gateway | Chyba upstream služby. |
| 503 | Service Unavailable | API je dočasně nedostupné. |
| 504 | Gateway Timeout | Upstream služba neodpověděla včas. |