Cost+Docs

Удостоверяване

Научете как да се удостоверявате с API на Cost+

Цялата комуникация с API на Cost+ изисква TLS 1.2 или по-нова версия и HTTP Basic Authentication.

Как работи Basic Auth

Удостоверявайте се, като използвате вашия API ключ като потребителско име с празна парола. Кодирайте в Base64 низа \{api_key\}: (обърнете внимание на двоеточието в края — паролата е празна).

Полученият Authorization хедър изглежда така:

Authorization: Basic aHVudGVyMjo=

Никога не излагайте вашия API ключ в клиентски код или публични хранилища. Пазете го само от страна на сървъра.

Използване на cURL

Стандартен начин (препоръчителен)

cURL поддържа Basic Auth нативно с флага -u. Подайте вашия API ключ, последван от двоеточие:

cURL with -u flag
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/

Ръчно Base64 кодиране

Ако предпочитате да конструирате хедъра сами, първо кодирайте ключа:

Encode the API key
echo -n "YOUR_API_KEY:" | base64

След това подайте кодираната стойност в хедъра Authorization:

cURL with manual Authorization header
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/

Двоеточието след API ключа е задължително — то разделя потребителското име от (празната) парола в схемата Basic Auth.

HTTP статус кодове

API-то използва стандартни HTTP статус кодове за указване на резултата от заявката.

Статус кодЗначениеОписание
200OKЗаявката е успешна.
201CreatedРесурсът е успешно създаден.
400Bad RequestЗаявката е неправилно формирана или липсват задължителни полета.
401UnauthorizedУдостоверяването е неуспешно — проверете вашия API ключ.
403ForbiddenНямате разрешение за достъп до този ресурс.
404Not FoundЗаявеният ресурс не съществува.
500Internal Server ErrorНещо се обърка от наша страна.
502Bad GatewayГрешка на услугата нагоре по веригата.
503Service UnavailableAPI-то е временно недостъпно.
504Gateway TimeoutУслугата нагоре по веригата не отговори навреме.

On this page