Cost+Docs

Awtentikazzjoni

Tgħallem kif tawtentika mal-API ta' Cost+

Il-komunikazzjoni kollha mal-API ta' Cost+ teħtieġ TLS 1.2 jew ogħla u HTTP Basic Authentication.

Kif Taħdem il-Basic Auth

Awtentika billi tuża ċ-ċavetta API bħala l-username b'password vojta. Ikkodifika Base64 l-string \{api_key\}: (innota l-colon fl-aħħar — il-password hija vojta).

Il-header Authorization li tirriżulta tidher hekk:

Authorization: Basic aHVudGVyMjo=

Qatt tesponi ċ-ċavetta API tiegħek f'kodiċi tal-klijent jew f'repożitorji pubbliċi. Żommha fuq is-server biss.

Bl-użu ta' cURL

Lest mill-kaxxa (rakkomandat)

cURL jappoġġja natturalment il-Basic Auth bil-flag -u. Għaddi ċ-ċavetta API segwita minn colon:

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

Ikkodifikar manwali Base64

Jekk tippreferi tibni l-header int, l-ewwel ikkodifika ċ-ċavetta:

Ikkodifika ċ-ċavetta API
echo -n "YOUR_API_KEY:" | base64

Imbagħad għaddi l-valur ikkodifikat fil-header Authorization:

cURL b'header manwali ta' Authorization
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/

Il-colon fl-aħħar wara ċ-ċavetta API hija meħtieġa — tissepara l-username mill-password (vojta) fl-iskema ta' Basic Auth.

Kodiċijiet tal-Istatus HTTP

L-API tuża kodiċijiet standard tal-istatus HTTP biex tindika r-riżultat ta' talba.

Kodiċi tal-IstatusTifsiraDeskrizzjoni
200OKIt-talba rnexxiet.
201MaħluqaIr-riżorsa nħolqot b'suċċess.
400Talba ĦażinaIt-talba kienet malformata jew nieqsa minn oqsma meħtieġa.
401Mhux AwtorizzatL-awtentikazzjoni falliet — iċċekkja ċ-ċavetta API tiegħek.
403IpprojbitM'għandekx permess li taċċessa din ir-riżorsa.
404Ma NstabxIr-riżorsa mitluba ma teżistix.
500Żball Intern tas-ServerXi ħaġa marret ħażin min-naħa tagħna.
502Bad GatewayŻball fis-servizz upstream.
503Servizz Mhux DisponibbliL-API temporanjament mhijiex disponibbli.
504Gateway TimeoutIs-servizz upstream ma rrispondiex fil-ħin.

On this page