DocsAutentifikācija
Uzziniet, kā autentificēties ar Cost+ API
Visai saziņai ar Cost+ API nepieciešams TLS 1.2 vai jaunāka versija un HTTP Basic autentifikācija.
Kā darbojas Basic Auth
Autentificējieties, izmantojot savu API atslēgu kā lietotājvārdu ar tukšu paroli. Base64 kodējiet virkni \{api_key\}: (ievērojiet beigu kolu — parole ir tukša).
Rezultātā Authorization galvene izskatās šādi:
Authorization: Basic aHVudGVyMjo=Nekad neatklājiet savu API atslēgu klienta puses kodā vai publiskos repozitorijos. Glabājiet to tikai servera pusē.
cURL izmantošana
Iebūvēts atbalsts (ieteicams)
cURL sākotnēji atbalsta Basic Auth ar -u karodziņu. Norādiet savu API atslēgu, kam seko kols:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Manuāla Base64 kodēšana
Ja vēlaties veidot galveni pats, vispirms kodējiet atslēgu:
echo -n "YOUR_API_KEY:" | base64Pēc tam norādiet kodēto vērtību Authorization galvenē:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Beigu kols pēc API atslēgas ir obligāts — tas atdala lietotājvārdu no (tukšās) paroles Basic Auth shēmā.
HTTP statusa kodi
API izmanto standarta HTTP statusa kodus, lai norādītu pieprasījuma rezultātu.
| Statusa kods | Nozīme | Apraksts |
|---|---|---|
| 200 | OK | Pieprasījums veiksmīgs. |
| 201 | Izveidots | Resurss veiksmīgi izveidots. |
| 400 | Nederīgs pieprasījums | Pieprasījums bija nepareizi formatēts vai trūkst obligāto lauku. |
| 401 | Neautorizēts | Autentifikācija neizdevās — pārbaudiet savu API atslēgu. |
| 403 | Aizliegts | Jums nav atļaujas piekļūt šim resursam. |
| 404 | Nav atrasts | Pieprasītais resurss neeksistē. |
| 500 | Iekšēja servera kļūda | Kaut kas nogāja greizi mūsu pusē. |
| 502 | Nederīga vārteja | Augšupējā pakalpojuma kļūda. |
| 503 | Pakalpojums nav pieejams | API ir īslaicīgi nepieejams. |
| 504 | Vārtejas noildze | Augšupējais pakalpojums neatbildēja laikā. |