DocsAutentimine
Õppige, kuidas autentida Cost+ API-ga
Kogu suhtlus Cost+ API-ga nõuab TLS 1.2 või uuemat versiooni ja HTTP Basic autentimist.
Kuidas Basic Auth töötab
Autentimiseks kasutage oma API võtit kasutajanimena ja tühja parooli. Base64-kodeerige string \{api_key\}: (pange tähele lõpus olevat koolonit — parool on tühi).
Tulemuseks saadav Authorization päis näeb välja selline:
Authorization: Basic aHVudGVyMjo=Ärge kunagi paljastage oma API võtit kliendipoolses koodis ega avalikes hoidlates. Hoidke see ainult serveripoolel.
cURL-i kasutamine
Sisseehitatud viis (soovitatav)
cURL toetab Basic Auth-i natiivset -u lipuga. Edastage oma API võti, millele järgneb koolon:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Käsitsi Base64 kodeerimine
Kui eelistate päise ise koostada, kodeerige kõigepealt võti:
echo -n "YOUR_API_KEY:" | base64Seejärel edastage kodeeritud väärtus Authorization päises:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/API võtme järel olev koolon on kohustuslik — see eraldab kasutajanime (tühjast) paroolist Basic Auth skeemis.
HTTP olekukoodid
API kasutab standardseid HTTP olekukoode päringu tulemuse näitamiseks.
| Olekukood | Tähendus | Kirjeldus |
|---|---|---|
| 200 | OK | Päring õnnestus. |
| 201 | Loodud | Ressurss loodi edukalt. |
| 400 | Vigane päring | Päring oli vigane või puudusid kohustuslikud väljad. |
| 401 | Volitamata | Autentimine ebaõnnestus — kontrollige oma API võtit. |
| 403 | Keelatud | Teil puudub õigus sellele ressursile juurde pääseda. |
| 404 | Ei leitud | Soovitud ressurssi ei eksisteeri. |
| 500 | Sisemine serveri viga | Meie poolel läks midagi valesti. |
| 502 | Vigane lüüs | Ülemise teenuse viga. |
| 503 | Teenus pole saadaval | API on ajutiselt kättesaamatu. |
| 504 | Lüüsi ajalõpp | Ülemine teenus ei vastanud õigeaegselt. |