Cost+Docs

Webhookeanna

Fógraí stádais íocaíochta fíor-ama a fháil

Ligeann webhookeanna do Cost+ do fhreastalaí a chur ar an eolas i bhfíor-am aon uair a athraíonn stádas ordaithe. In ionad an API a phóláil, cuireann tú URL ar fáil agus seolann Cost+ iarratas HTTP POST chuige aon uair a bhíonn nuashonrú ann.

Conas a Oibríonn Webhookeanna

  1. Sonraíonn tú webhook_url agus ordú á chruthú agat, nó cumraíonn tú URL webhook réamhshocraithe ag leibhéal an tionscadail.
  2. Nuair a athraíonn stádas an ordaithe (m.sh., ó new go completed), seolann Cost+ iarratas POST chuig do URL webhook.
  3. Faigheann do fhreastalaí an webhook, ansin glaonn sé API Cost+ chun sonraí iomlána an ordaithe a fháil.
  4. Nuashonraíonn tú do chóras bunaithe ar stádas fíoraithe an ordaithe.

Ná bí ag brath ar an sonraí webhook amháin chun ordú a chomhlíonadh riamh. Fíoraigh stádas an ordaithe i gcónaí trí iarratas GET /v1/orders/{id}/ a dhéanamh tar éis webhook a fháil. Is meicníocht fógra é an webhook, ní foinse fírinne.

Sonraí Webhook

Is réad JSON é corp an webhook a bhfuil an cineál imeachta agus aitheantas an ordaithe ann:

{
  "event": "status_changed",
  "order_id": "b9ae6...",
  "project_id": "proj_abc123"
}
RéimseCur Síos
eventCineál an imeachta. Faoi láthair status_changed le haghaidh nuashonruithe ordaithe.
order_idAitheantóir uathúil an ordaithe a d'athraigh stádas.
project_idAn tionscadal lena mbaineann an t-ordú.

An URL Webhook a Shocrú

Is féidir leat an URL webhook a shocrú ar dhá bhealach:

In aghaidh an Ordaithe

Cuir an réimse webhook_url san áireamh agus ordú á chruthú:

{
  "currency": "EUR",
  "amount": 1295,
  "webhook_url": "https://www.example.com/webhook"
}

Réamhshocrú Tionscadail

Cumraigh URL webhook réamhshocraithe i do dheais Cost+ faoi shocruithe an tionscadail. Úsáidfear an URL seo do gach ordú nach sonraíonn a webhook_url féin.

Fiú má tá réamhshocrú ag leibhéal an tionscadail agat, is féidir leat é a shárú ar bhonn in aghaidh an ordaithe trí webhook_url a chur san áireamh san iarratas cruthaithe ordaithe.

Loighic Atrialacha

Mura bhfreagraíonn do fhreastalaí le cód stádais 2xx, déanann Cost+ atriail ar sheachadadh an webhook:

  • Uasatrialacha: 10 n-iarracht
  • Eatramh idir atrialacha: 2 nóiméad idir gach iarracht
  • Am istigh na chéad iarrachta: 4 soicind
  • Am istigh na n-iarrachtaí ina dhiaidh sin: 10 soicind

Má theipeann ar gach ceann den 10 n-iarracht atrialacha, marcáiltear an webhook mar theipthe. Is féidir leat stádas an ordaithe a fháil am ar bith fós trí phóláil an API.

Bí cinnte go bhfreagraíonn do chríochphointe webhook go tapa (laistigh de 4 soicind don chéad iarracht). Déan aon phróiseáil fhadchúrsa go hasincrónach tar éis freagra 200 OK a sheoladh ar ais.

Dea-Chleachtais

  • Fíoraigh tríd an API i gcónaí. Tar éis webhook a fháil, glaoigh GET /v1/orders/\{order_id\}/ chun an stádas reatha a dhearbhú sula ndéanann tú gníomh cosúil le hearraí a sheoladh nó rochtain a dheonú.
  • Seol 200 ar ais go tapa. Admhaigh an webhook le freagra 200 láithreach agus próiseáil an t-ordú go hasincrónach chun am istigh a sheachaint.
  • Láimhseáil dúblach. D'fhéadfadh do chríochphointe webhook an imeacht céanna a fháil níos mó ná uair amháin. Bí cinnte go bhfuil do loighic phróiseála idéimpotent.
  • Úsáid HTTPS. Úsáid URL HTTPS i gcónaí do do chríochphointe webhook chun a chinntiú go dtarchuirtear an sonraí go slán.
  • Logáil sonraí webhook. Stóráil sonraí webhook isteach le haghaidh dífhabhtaithe agus iniúchóireachta.

Críochphointí Gaolmhara

On this page