Cost+Docs

Fíordheimhniú

Foghlaim conas fíordheimhniú a dhéanamh le API Cost+

Éilíonn gach cumarsáid le API Cost+ TLS 1.2 nó níos airde agus Fíordheimhniú Bunúsach HTTP.

Conas a Oibríonn Fíordheimhniú Bunúsach

Fíordheimhnigh trí d'eochair API a úsáid mar an t-ainm úsáideora le pasfhocal folamh. Ionchódaigh Base64 an teaghrán \{api_key\}: (tabhair faoi deara an idirstad deiridh — tá an pasfhocal folamh).

Breathnaíonn an ceanntásc Authorization mar seo:

Authorization: Basic aHVudGVyMjo=

Ná nocht d'eochair API i gcód ar thaobh an chliaint ná i stórais phoiblí. Coinnigh ar thaobh an fhreastalaí amháin í.

cURL a Úsáid

As an mbosca (molta)

Tacaíonn cURL go dúchasach le Fíordheimhniú Bunúsach leis an mbratach -u. Cuir d'eochair API isteach agus idirstad ina diaidh:

cURL with -u flag
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/

Ionchódú Base64 de láimh

Más fearr leat an ceanntásc a thógáil tú féin, ionchódaigh an eochair ar dtús:

Encode the API key
echo -n "YOUR_API_KEY:" | base64

Ansin cuir an luach ionchódaithe sa cheanntásc Authorization:

cURL with manual Authorization header
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/

Tá an idirstad deiridh i ndiaidh na heochrach API riachtanach — scarann sé an t-ainm úsáideora ón bpasfhocal (folamh) sa scéim Fíordheimhnithe Bunúsaigh.

Cóid Stádais HTTP

Úsáideann an API cóid stádais HTTP caighdeánacha chun toradh iarratais a léiriú.

Cód StádaisBríCur Síos
200OKD'éirigh leis an iarratas.
201CruthaitheCruthaíodh an acmhainn go rathúil.
400DrochiarratasBhí an iarratas míchumtha nó bhí réimsí riachtanacha in easnamh.
401NeamhúdaraitheTheip ar an bhfíordheimhniú — seiceáil d'eochair API.
403ToirmisctheNíl cead agat rochtain a fháil ar an acmhainn seo.
404Gan AimsiúNíl an acmhainn iarrtha ann.
500Earráid Inmheánach FreastalaíChuaigh rud éigin mícheart ar ár dtaobh.
502DrochgheataEarráid seirbhíse suas-sruth.
503Seirbhís NeamhfháilNíl an API ar fáil go sealadach.
504Am Istigh an GheataNíor fhreagair an tseirbhís suas-sruth in am.

On this page