DocsAuðkenning
Lærðu hvernig á að auðkenna við Cost+ API
Öll samskipti við Cost+ API krefjast TLS 1.2 eða hærra og HTTP Basic auðkenningar.
Hvernig Basic Auth virkar
Auðkenndu þig með því að nota API lykilinn þinn sem notandanafn með tómu lykilorði. Base64-kódaðu strenginn \{api_key\}: (athugaðu tvípunktinn á eftir — lykilorðið er tómt).
Authorization hausinn lítur svona út:
Authorization: Basic aHVudGVyMjo=Aldrei afhjúpaðu API lykilinn þinn í kóða á biðlarahlið eða í opinberum geymslum. Haltu honum aðeins á þjónahlið.
Notkun cURL
Innbyggð notkun (ráðlögð)
cURL styður natively Basic Auth með -u flagginu. Sendu API lykilinn þinn á eftir tvípunkti:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Handvirk Base64 kóðun
Ef þú vilt setja saman hausinn sjálf/ur, kódaðu lykilinn fyrst:
echo -n "YOUR_API_KEY:" | base64Sendu síðan kóðaða gildið í Authorization hausnum:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Tvípunkturinn á eftir API lyklinum er nauðsynlegur — hann aðgreinir notandanafnið frá (tóma) lykilorðinu í Basic Auth skemanu.
HTTP stöðukóðar
API notar staðlaða HTTP stöðukóða til að gefa til kynna niðurstöðu beiðni.
| Stöðukóði | Merking | Lýsing |
|---|---|---|
| 200 | OK | Beiðni tókst. |
| 201 | Búið til | Auðlind var búin til. |
| 400 | Slæm beiðni | Beiðnin var röng eða vantar nauðsynlega reiti. |
| 401 | Óheimilt | Auðkenning mistókst — athugaðu API lykilinn þinn. |
| 403 | Bannað | Þú hefur ekki heimild til að nálgast þessa auðlind. |
| 404 | Fannst ekki | Umbeðin auðlind er ekki til. |
| 500 | Innri villa þjóns | Eitthvað fór úrskeiðis á okkar enda. |
| 502 | Slæm gátt | Villa í upstream þjónustu. |
| 503 | Þjónusta ekki tiltæk | API er tímabundið ótiltækt. |
| 504 | Tímamörk gáttar | Upstream þjónustan svaraði ekki í tíma. |