DocsAutentifikacija
Sužinokite, kaip autentifikuotis su Cost+ API
Visam bendravimui su Cost+ API reikalingas TLS 1.2 arba naujesnė versija ir HTTP Basic autentifikacija.
Kaip veikia Basic Auth
Autentifikuokitės naudodami savo API raktą kaip vartotojo vardą su tuščiu slaptažodžiu. Base64 koduokite eilutę \{api_key\}: (atkreipkite dėmesį į dvitaškį gale — slaptažodis yra tuščias).
Gautas Authorization antraštė atrodo taip:
Authorization: Basic aHVudGVyMjo=Niekada neatsklleiskite savo API rakto kliento pusės kode ar viešosiose saugyklose. Laikykite jį tik serverio pusėje.
cURL naudojimas
Iš karto (rekomenduojama)
cURL natūraliai palaiko Basic Auth su -u vėliavėle. Perduokite savo API raktą, po kurio seka dvitaškis:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Rankinis Base64 kodavimas
Jei pageidaujate patys sudaryti antraštę, pirmiausia užkoduokite raktą:
echo -n "YOUR_API_KEY:" | base64Tada perduokite užkoduotą reikšmę Authorization antraštėje:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Dvitaškis po API rakto yra privalomas — jis atskiria vartotojo vardą nuo (tuščio) slaptažodžio Basic Auth schemoje.
HTTP būsenos kodai
API naudoja standartinius HTTP būsenos kodus, nurodančius užklausos rezultatą.
| Būsenos kodas | Reikšmė | Aprašymas |
|---|---|---|
| 200 | OK | Užklausa sėkminga. |
| 201 | Sukurta | Išteklius sėkmingai sukurtas. |
| 400 | Bloga užklausa | Užklausa buvo netinkamai suformuota arba trūksta privalomų laukų. |
| 401 | Neautorizuota | Autentifikacija nepavyko — patikrinkite savo API raktą. |
| 403 | Draudžiama | Neturite leidimo pasiekti šio ištekliaus. |
| 404 | Nerasta | Prašomas išteklius neegzistuoja. |
| 500 | Vidinė serverio klaida | Kažkas nutiko mūsų pusėje. |
| 502 | Blogas šliuzas | Aukštesnio lygio paslaugos klaida. |
| 503 | Paslauga nepasiekiama | API laikinai nepasiekiamas. |
| 504 | Šliuzo skirtasis laikas | Aukštesnio lygio paslauga neatsakė laiku. |