DocsTodennus
Opi todentamaan Cost+ API:n kanssa
Kaikki viestintä Cost+ API:n kanssa edellyttää TLS 1.2:ta tai uudempaa sekä HTTP Basic -todennusta.
Miten Basic Auth toimii
Todenna käyttämällä API-avainta käyttäjänimenä ja tyhjää salasanaa. Base64-koodaa merkkijono \{api_key\}: (huomaa loppuun jäävä kaksoispiste — salasana on tyhjä).
Tuloksena oleva Authorization-otsikko näyttää tältä:
Authorization: Basic aHVudGVyMjo=Älä koskaan paljasta API-avaintasi asiakaspuolen koodissa tai julkisissa tietovarastoissa. Pidä se vain palvelinpuolella.
cURL:n käyttö
Valmis ratkaisu (suositeltava)
cURL tukee natiivisti Basic Auth -todennusta -u-lipulla. Syötä API-avaimesi ja sen perään kaksoispiste:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Manuaalinen Base64-koodaus
Jos haluat muodostaa otsikon itse, koodaa ensin avain:
echo -n "YOUR_API_KEY:" | base64Syötä sitten koodattu arvo Authorization-otsakkeeseen:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/API-avaimen perässä oleva kaksoispiste on pakollinen — se erottaa käyttäjänimen (tyhjästä) salasanasta Basic Auth -skeemassa.
HTTP-tilakoodit
API käyttää tavallisia HTTP-tilakoodeja ilmaisemaan pyynnön tuloksen.
| Tilakoodi | Merkitys | Kuvaus |
|---|---|---|
| 200 | OK | Pyyntö onnistui. |
| 201 | Created | Resurssi luotiin onnistuneesti. |
| 400 | Bad Request | Pyyntö oli virheellinen tai siitä puuttui pakollisia kenttiä. |
| 401 | Unauthorized | Todennus epäonnistui — tarkista API-avaimesi. |
| 403 | Forbidden | Sinulla ei ole oikeutta käyttää tätä resurssia. |
| 404 | Not Found | Pyydettyä resurssia ei ole olemassa. |
| 500 | Internal Server Error | Jokin meni vikaan meidän päässämme. |
| 502 | Bad Gateway | Upstream-palvelun virhe. |
| 503 | Service Unavailable | API on tilapäisesti poissa käytöstä. |
| 504 | Gateway Timeout | Upstream-palvelu ei vastannut ajoissa. |