POS Posting API do mhonarchaithe cuntar
Bíonn an STRYK POS Posting API ag áirithint muirear ó do chuntar ar chuntais seomraí aíonna atá cláraithe. Taispeánann an tagairt clárú, áirithint, cealú agus webhooks.
Contents
Forbhreathnú
Is comhéadan freastalaí go freastalaí é an API do mhuirir ar fhanachtaí cláraithe. Ceangalann an t-óstán do chuntar faoi Socruithe faoi POS: Ceangail cuntar. Faigheann an cuntar eochair agus an Seoladh don chuntar ansin.
| Eolas | Luach |
|---|---|
| Bunseoladh | https://app.staystryk.com/api/v1/pos/public |
| Clárú | Eochair Bearer an óstáin sa cheannlíne Authorization |
| Coinníoll | Tá an modúl breise STRYK POS gníomhach ag an óstán |
| Gan modúl breise | Freagraíonn gach glaoch le 403 agus leis an gcód module_disabled. Ní scríobhann STRYK aon mhuirear. |
| Teorainn glaonna | 100 iarratas in 60 soicind agus in aghaidh na heochrach. Ina dhiaidh sin freagraíonn STRYK le 429. |
| Leagan na tuairisce | 1.3.0 |
Eochracha agus slándáil
- Tosaíonn an eochair le
pos_live_. Feiceann an t-óstán í uair amháin nuair a chruthaítear í. - Seol é ar an bhfreastalaí amháin trí HTTPS sa cheanntáisc:
Authorization: Bearer <vollständiger Schlüssel>. Riamh mar pharaiméadar sa seoladh. - Baineann eochair le hóstán amháin go díreach agus le haschur roghnach. Cruthaíonn an t-óstán eochair amháin do gach nasc.
- Ciallaíonn 401 nach raibh STRYK in ann an eochair a sheiceáil. Seiceáil an chumraíocht agus stádas oibriúcháin. Ná athraigh an eochair go huathoibríoch.
- Is raon idempotence nua é eochair nua. Ní aimsíonn sé ná ní chealaíonn sé muirir na sean-eochrach. Oibrigh na hordaithe oscailte agus cuir i gcomhréir iad sula gcúlghairfidh an t-óstán an sean-eochair.
- Má tá eochair caillte nó compromised, cúlghairfidh an t-óstán í le Cúlghair an eochair agus socróidh sé oibríochtaí neamhshábháilte in STRYK sula seolann do chuntar ionad uirthi.
Cuntas seomra agus suimeanna
| Modh agus conair | Cuspóir |
|---|---|
GET /ping | Ní sheiceálann sé ach an nglacann an eochair. |
GET /accounts | Liostaíonn sé na cuntais seomraí atá cláraithe faoi láthair, na cinn bhactha san áireamh. |
GET /room-lookup?room=105 | Réitíonn sé seomra go dtí an fanacht chláraithe. 404 gan aoi meaitseálach, 409 i gcás seomra débhríoch. |
Tá na réimsí seo sa chuntas seomra:
| Réimse | Brí |
|---|---|
bookingId, bookingNumber, guestName, roomNumber | Fanacht agus seomra |
allowPosting | Thug an t-óstán cead muirir don fhanacht. Níl sé sin leordhóthanach ina aonar. |
allowCharge | Seiceáil iomlán ó cheadú, teorainn fhágtha agus cuntas dúnta. Seiceáil díreach roimh áirithint. |
postingBlockReason | no_post, credit_limit_reached, account_closed nó folamh |
openChargesCount, openChargesTotal, stayChargesTotal | Muirir oscailte agus suim na muirear nach bhfuil cealaithe |
creditLimit, remainingCredit, currency | Teorainn, teorainn fhágtha agus airgeadra an óstáin |
Taispeáin aoi agus seomra le haghaidh deimhnithe agus seol bookingId in éineacht le room. Ná coinnigh liosta na gcuntas mar eolaire aoi go buan. Is uimhreacha JSON in airgeadra an óstáin iad suimeanna. Is é an tsaoráid HALF_UP: méideanna go trí ionad deachúil, suimeanna go dhá ionad deachúil.
Iontráil agus athdhéanamh
| Modh agus conair | Cuspóir |
|---|---|
POST /charges | Áirithíonn muirear ar chuntas seomra. Freagra 201 leis an muirear. |
POST /charges/batch | Áirithíonn 1 go 50 muirear le chéile. Áirithítear gach muirear nua nó níor áirithíodh aon cheann. Leanann an freagra ord an iarratais. |
GET /charges/{externalRef} | Soláthraíonn sé stádas buan an mhuirir, cancelled agus transferred san áireamh. |
Réimsí áirithinte:
| Réimse | Riachtanach | Brí |
|---|---|---|
bookingId, room | ceann amháin ar a laghad | Seomra mar théacs le litreacha, ní mar uimhir. Ní mór an bheirt acu a bheith ag teacht le chéile. |
description | tá | 1 go 500 carachtar |
unitPrice | tá | Praghas bruto in aghaidh an aonaid, níos mó ná 0, 99999.99 ar a mhéad |
externalRef | tá | Eochair uathúil cáipéise nó muirir, 1 go 255 carachtar, mar shampla receipt-123-item-1 |
quantity | níl | 0,001 go 9999, réamhshocrú 1 |
unit | níl | ar a mhéad 20 carachtar, réamhshocrú Stk. |
taxRate | níl | Ráta cánach gníomhach an óstáin. Mura luaitear é, baineann an réamhshocrú an aschuir úsáid as, agus ansin an príomh-cheann. |
currency | níl | Ní mór airgeadra an óstáin a bheith ann |
outletId | níl | Le heochair a bhaineann le haschur, baineann an t-aschur seo úsáid as. Tugann luach eile 403. |
chargedAt | níl | Am na seirbhíse, réamhshocrú anois, 5 nóiméad ar a mhéad sa todhchaí |
notes, posRef | níl | Nóta (1000 carachtar), tagairt cáipéise don fháiltiú (100 carachtar) |
Tá an t-iomlán ó mhéid agus praghas aonaid níos mó ná 0 agus 99999999.99 ar a mhéad.
Is eochair idempotence dochorraithe é externalRef ón óstán agus ón eochair. Tugann athdhéanamh cruinn an muirear bunaidh le idempotentReplay=true. Tugann ábhar athraithe nó eochair chealaithe 409.
Tar éis timeout nó 5xx léann tú GET /charges/{externalRef} ar dtús. Seolann tú an t-iarratas céanna arís, leis an eochair chéanna gan athrú, ach amháin nuair a dheimhnítear 404. Sábháil iarratais sula seolann tú iad agus ná hathraigh riamh chargedAt, praghas, cáin nó tagairt. Má thaispeánann an freagra duplicateWarning, tá an muirear curtha ar leabhar cheana. Cuir i gcomhréir é in STRYK agus ná seol arís é.
| Stádas | Brí |
|---|---|
| 400 | Sonraí neamhbhailí, ceartaigh iad. |
| 401 | Eochair nach féidir a sheiceáil |
| 403 | Raon nach bhfuil ceadaithe, mar shampla outlet mícheart |
| 404 | Cuntas nó muirear nach bhfuil ann |
| 409 | Coimhlint ghnó. Seiceáil an cód, ná déan athdhéanamh dall. |
| 429 | Teorainn glaonna, fan 60 soicind ar a laghad |
| 5xx | Cuir i gcomhréir ar dtús, ansin déan athdhéanamh le backoff teoranta |
I measc chódanna an fhreagra earráide tá pos_currency_mismatch, pos_external_ref_conflict, pos_external_ref_cancelled, pos_room_required, pos_guest_not_inhouse, pos_posting_blocked, pos_credit_limit_exceeded, pos_charge_already_invoiced agus pos_account_closed. Ná brainsigh de réir an téacs Gearmáinise. Cabhraíonn requestId leis an tacaíocht.
Cealú agus sonrasc
Cealaíonn DELETE /charges/{externalRef} muirear oscailte d'eochair. Sa chorp tá reason roghnach (500 carachtar ar a mhéad). Tugann athdhéanamh an muirear cealaithe arís.
- Is é
open,cancellednótransferredstádas muirir. - Fanann muirear
opengo dtí go gcruthaíonn an seiceáil amach sonrasc. Ansin glacann STRYK muirir oscailte mar mhíreanna sonraisc, agus athraíonn an stádas gotransferred. - Tugann muirear glactha 409 le
pos_charge_already_invoiced. Ceartaíonn an t-óstán é sa chuntasaíocht: Sonrasc a cheartú. - Ní scriosann cealú rud ar bith agus ní thugann sé airgead ar ais. Fanann an muirear cealaithe inrianaithe.
Ní áirithíonn an API ach muirir dhearfacha. Ná seol íoctha a chríochnaítear ag an gcuntar ar an seomra freisin. Le híoc roinnte ní sheolann tú ach an sciar oscailte seomra le cáin dháilte i gceart. Bain lascainí ón bpraghas bruto sula n-áirithíonn tú.
Webhooks agus glacadh
Cruthaíonn an t-óstán webhooks faoi Socruithe faoi POS: Cruthaigh webhooks.
| Eolas | Luach |
|---|---|
| Imeachtaí | charge.posted, charge.cancelled, agus ping le linn tástála |
Ceanntásc X-STRYK-Event | Ainm an imeachta |
Ceanntásc X-STRYK-Webhook-Id | ID an webhook, ní an tseachadta |
Ceanntásc X-STRYK-Signature | sha256= agus HMAC-SHA-256 ar bhearta neamhathraithe an iarratais. Ach amháin le rún cumraithe. |
| Corp | event, hotelId, timestamp, data le chargeId, externalRef, bookingId, roomNumber, guestName, description, grossAmount, currency agus an t-aschur |
| Freagra | 2xx tar éis glactha buan laistigh de 10 soicind. Ní leanann STRYK athsheolta. |
| Athsheoladh | Tar éis 30 soicind, 5 nóiméad, 30 nóiméad agus 2 uair an chloig, go dtí an teorainn stóráilte |
Deimhnigh an síniú ar an gcorp neamhathraithe sula léann tú é mar JSON. Stóraigh event agus data.chargeId go buan chun athsheoltaí a aithint. Is féidir seachadtaí a bheith dúbailte nó in ord eile: ní fhorscríobhann sean-charge.posted charge.cancelled. Níl webhooks ann le haghaidh sealbhú isteach, seiceáil amach ná glacadh sonraisc. Léigh an staid arís ansin.
Liosta glactha le hóstán tástála agus fíorfhanacht tástála cláraithe:
- Seiceáil
/pingagus an cheangal aoi agus seomra, fiú le háirithintí le seomraí iolracha. - Seiceáil cáin, airgeadra agus srianadh aschuir na heochrach.
- Athdhéanamh cruinn gan dúbailt muirir, ábhar athraithe le 409, freagra caillte le comhréiteach.
- Baisc ar fad nó dada, glas agus teorainn, cealú agus athdhéanamh cealaithe.
- Sonraisc seiceála amach agus diúltú cealaithe tar éis an aistrithe.
- Webhook sínithe, síniú neamhbhailí, seachadadh dúbailte agus neamhordúil.
- Taispeántas earráide, athrú eochrach agus comhréiteach ag an bhfoireann.
Tagairt theicniúil
Tá an tuairisc iomlán ar fáil mar chomhad OpenAPI i mBéarla, mar YAML ag /developers/pos/openapi.yaml agus mar JSON ag /developers/pos/openapi.json ar shuíomh STRYK. San óstán treoraíonn Doiciméadú teicniúil faoi Don teicneoir cuntair faoi Socruithe faoi POS chuig an leathanach seo.
| Modh | Conair | Cur síos gairid |
|---|---|---|
| GET | /ping | Nasc a sheiceáil |
| GET | /accounts | Liostaigh cuntais seomraí cláraithe |
| GET | /room-lookup | Aimsigh fanacht le seomra |
| POST | /charges | Áirithigh muirear |
| POST | /charges/batch | Áirithigh suas le 50 muirear le chéile |
| GET | /charges/{externalRef} | Léigh stádas muirir |
| DELETE | /charges/{externalRef} | Cealaigh muirear oscailte |