Fara beint í efnið
Reference, STRYK POS

POS Posting API fyrir kassaframleiðendur

Með STRYK POS Posting API bókar þú liði úr kassanum þínum á herbergisreikninga gesta sem eru innritaðir. Viðmiðið sýnir skráningu, bókun, afbókun og webhook.

Last updated: Developers
Contents
  1. Yfirlit
  2. Lyklar og öryggi
  3. Herbergisreikningur og upphæðir
  4. Bóka og endurtaka
  5. Afbókun og reikningur
  6. Webhook og samþykkt
  7. Tæknileg tilvísun

Yfirlit

API-ið er netþjónn-til-netþjóns tengi fyrir liði á innritaða dvöl. Hótelið tengir kassann þinn í Stillingar undir POS: Tengja kassa. Þar fær kassinn lykil og Vistfang fyrir kassann.

AtriðiGildi
Grunnvefslóðhttps://app.staystryk.com/api/v1/pos/public
SkráningBearer-lykill hótelsins í hausnum Authorization
ForsendaHótelið er með viðbótareininguna STRYK POS virka
Án viðbótareiningarHvert kall svarar með 403 og kóðanum module_disabled. STRYK skrifar engan lið.
Takmörk á köllum100 beiðnir á 60 sekúndum og lykil. Eftir það svarar STRYK með 429.
Útgáfa lýsingarinnar1.3.0

Lyklar og öryggi

  • Lykillinn byrjar á pos_live_. Hótelið sér hann aðeins einu sinni þegar hann er búinn til.
  • Sendu hann aðeins frá þjóninum yfir HTTPS í hausnum: Authorization: Bearer <vollständiger Schlüssel>. Aldrei sem færibreytu í slóðinni.
  • Lykill tilheyrir einu hóteli og valfrjálst einum sölustað. Hótelið býr til einn lykil fyrir hverja tengingu.
  • 401 þýðir að STRYK gat ekki staðfest lykilinn. Athugaðu stillingar og rekstrarstöðu. Skiptu ekki um lykil sjálfkrafa.
  • Nýr lykill er nýtt svið fyrir idempotency. Hann finnur ekki og afbókar ekki liði gamla lykilsins. Kláraðu opin verk og samræmdu þau áður en hótelið afturkallar gamla lykilinn.
  • Ef lykill tapast eða verður fyrir broti afturkallar hótelið hann með Afturkalla lykil og fer yfir óöruggar aðgerðir í STRYK áður en kassinn þinn sendir staðgengil.

Herbergisreikningur og upphæðir

Aðferð og slóðTilgangur
GET /pingAthugar aðeins hvort lykillinn er samþykktur.
GET /accountsListar herbergisreikninga sem eru innritaðir núna, líka þá sem eru læstir.
GET /room-lookup?room=105Finnur dvöl fyrir herbergi. 404 ef enginn gestur passar, 409 ef herbergið er tvírætt.

Herbergisreikningurinn inniheldur þessi svið:

SviðMerking
bookingId, bookingNumber, guestName, roomNumberDvöl og herbergi
allowPostingHótelið hefur leyft liði á dvölina. Eitt og sér nægir það ekki.
allowChargeHeildarprófun úr leyfi, eftirstöðvum heimildar og lokuðum reikningi. Athugaðu hana rétt fyrir bókun.
postingBlockReasonno_post, credit_limit_reached, account_closed eða tómt
openChargesCount, openChargesTotal, stayChargesTotalOpnir liðir og summa allra liða sem eru ekki afbókaðir
creditLimit, remainingCredit, currencyHeimild, eftirstöðvar heimildar og gjaldmiðill hótelsins

Sýndu gest og herbergi til staðfestingar og sendu bookingId ásamt room. Geymdu ekki listann yfir reikninga sem varanlega gestaskrá. Upphæðir eru JSON-tölur í gjaldmiðli hótelsins. Námundun er HALF_UP: magn á þrjá, upphæðir á tvo aukastafi.

Bóka og endurtaka

Aðferð og slóðTilgangur
POST /chargesBókar lið á herbergisreikning. Svar 201 með liðnum.
POST /charges/batchBókar 1 til 50 liði saman. Allir nýir liðir eru bókaðir eða enginn. Svarið fylgir röð beiðninnar.
GET /charges/{externalRef}Skilar varanlegri stöðu liðar, líka cancelled og transferred.

Svið bókunar:

SviðSkyldaMerking
bookingId, rooma.m.k. eittHerbergi sem texti með bókstöfum, ekki tala. Ef bæði eru gefin verða þau að passa saman.
descriptionjá1 til 500 stafir
unitPricejáBrúttóverð á einingu, stærra en 0, mest 99999.99
externalRefjáEinstakur fylgiseðils- eða liðalykill, 1 til 255 stafir, til dæmis receipt-123-item-1
quantitynei0,001 til 9999, sjálfgefið 1
unitneimest 20 stafir, sjálfgefið Stk.
taxRateneiVirkt skatthlutfall hótelsins. Ef ekkert er gefið gildir sjálfgefið fyrir sölustaðinn, annars það miðlæga.
currencyneiVerður að vera gjaldmiðill hótelsins
outletIdneiMeð lykli sem er tengdur sölustað gildir sá sölustaður. Annað gildi gefur 403.
chargedAtneiTímapunktur þjónustu, sjálfgefið núna, mest 5 mínútur fram í tímann
notes, posRefneiAthugasemd (1000 stafir), tilvísun á fylgiseðil fyrir móttökuna (100 stafir)

Heildarupphæð úr magni og einingarverði er stærri en 0 og mest 99999999.99.

externalRef er óbreytanlegur idempotency-lykill hótels og lykils. Nákvæm endurtekning skilar upprunalega liðnum með idempotentReplay=true. Breytt efni eða afbókaður lykill gefur 409.

Eftir tímamörk eða 5xx lest þú fyrst GET /charges/{externalRef}. Aðeins ef 404 er staðfest sendir þú sömu beiðni óbreytta með sama lykli aftur. Vistaðu beiðnir áður en þær eru sendar og breyttu aldrei chargedAt, verði, skatti eða tilvísun. Ef svarið sýnir duplicateWarning er liðurinn þegar bókaður. Samræmdu hann í STRYK og sendu ekki aftur.

StaðaMerking
400Ógild gögn, leiðréttu þau.
401Lykill ekki hægt að staðfesta
403Svæði ekki leyft, til dæmis rangur sölustaður
404Reikningur eða liður er ekki til
409Efnisleg árekstur. Athugaðu kóðann og endurtaktu ekki blint.
429Takmörk á köllum, bíddu í að minnsta kosti 60 sekúndur
5xxSamræmdu fyrst, endurtaktu svo með takmörkuðu bakkoff

Villukóðar svarsins eru meðal annars 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 og pos_account_closed. Greindu ekki eftir þýska textanum. requestId hjálpar stuðningnum.

Afbókun og reikningur

DELETE /charges/{externalRef} afbókar opinn lið lykilsins þíns. Í meginmálinu má gefa valfrjálst reason (mest 500 stafir). Endurtekning skilar afbókaða liðnum aftur.

  • Staða liðar er open, cancelled eða transferred.
  • Liður helst open þar til útritun býr til reikninginn. Þá tekur STRYK opna liði yfir í reikningslínur og staðan breytist í transferred.
  • Liður sem hefur verið yfirtekinn gefur 409 með pos_charge_already_invoiced. Hótelið leiðréttir hann í bókhaldinu: Leiðrétta reikning.
  • Afbókun eyðir engu og endurgreiðir engu. Afbókaði liðurinn er áfram rekjanlegur.

API-ið bókar jákvæða liði. Greiðslur sem klárast við kassann sendir þú ekki líka á herbergið. Við skipta greiðslu sendir þú aðeins opna herbergishlutann með réttri skiptingu skatts. Afslætti dregur þú frá brúttóverðinu áður en bókað er.

Webhook og samþykkt

Hótelið bætir við webhook í Stillingar undir POS: Búa til webhook.

AtriðiGildi
Atburðircharge.posted, charge.cancelled, við prófun ping
Hausinn X-STRYK-EventHeiti atburðar
Hausinn X-STRYK-Webhook-IdAuðkenni webhook, ekki sendingarinnar
Hausinn X-STRYK-Signaturesha256= og HMAC-SHA-256 af óbreyttum bætum beiðninnar. Aðeins með stilltu leyndarmáli.
Meginmálevent, hotelId, timestamp, data með chargeId, externalRef, bookingId, roomNumber, guestName, description, grossAmount, currency og sölustað
Svar2xx eftir varanlega móttöku innan 10 sekúndna. STRYK fylgir ekki tilvísunum.
EndurtekningEftir 30 sekúndur, 5 mínútur, 30 mínútur og 2 klukkustundir, þar til vistuðu mörkum er náð

Staðfestu undirskriftina yfir óbreytt meginmál áður en þú lest það sem JSON. Vistaðu event og data.chargeId varanlega til að greina endurtekningar. Sendingar geta komið tvisvar eða í annarri röð: gamalt charge.posted yfirskrifar ekki charge.cancelled. Fyrir innritun, útritun og yfirtöku reiknings eru engir webhook. Lestu ástandið þar aftur.

Samþykktarlisti með einu prófunarhóteli og einni raunverulegri innritaðri prófunardvöl:

  1. Athugaðu /ping og úthlutun gests og herbergis, líka við bókanir með mörgum herbergjum.
  2. Athugaðu skatt, gjaldmiðil og takmörkun lykilsins á sölustað.
  3. Nákvæm endurtekning án tvöfaldra liða, breytt efni með 409, týnt svar með samræmingu.
  4. Batch allt eða ekkert, læsing og takmörk, afbókun og endurtekin afbókun.
  5. Summur reiknings við útritun og höfnun afbókunar eftir yfirtöku.
  6. Undirritaður webhook, ógild undirskrift, tvítekin og víxluð sending.
  7. Villuskjár, lykilskipti og samræming af starfsfólki.

Tæknileg tilvísun

Full lýsing er til sem OpenAPI-skrá á ensku, sem YAML á /developers/pos/openapi.yaml og sem JSON á /developers/pos/openapi.json á vefsíðu STRYK. Í hótelinu fer Tæknileg skjölun í hlutann Fyrir tæknimann kassans undir Stillingar og POS á þessa síðu.

AðferðSlóðStutt lýsing
GET/pingAthuga tengingu
GET/accountsLista innritaða herbergisreikninga
GET/room-lookupFinna dvöl fyrir herbergi
POST/chargesBóka einn lið
POST/charges/batchBóka allt að 50 liði saman
GET/charges/{externalRef}Lesa stöðu liðar
DELETE/charges/{externalRef}Afbóka einn opinn lið
Tengiliður