Webhooks agus API - BoothDock Wiki

Is féidir le BoothDock Studio ríomhchláir eile a chur ar an eolas faoi gach céim de sheisiún (webhooks) agus ligean do ríomhchláir eile é a rialú (API áitiúil). Gheobhaidh tú an dá rud sa rannán riaracháin faoi Córas → Uathoibriú.

I BoothDock Studio 1.4.0 agus i leaganacha níos sine, tugtar “Truicir” ar na webhooks ansin fós.

Níl webhooks ná easpórtáil fíor-ama ar fáil ach ar Windows. Tá an API áitiúil ar fáil ar iPad agus iPhone freisin ó leagan 1.4.0 ar aghaidh.

Úsáidí tipiciúla: soilse nó DMX i gcomhréir leis an gcomhaireamh síos, forleagan sruthaithe, áiritheoir ag an mbealach isteach – nó Stream Deck mar chianrialtán don Bhosca.

Córas → Uathoibriú: easpórtáil fíor-ama, webhooks agus API áitiúil

Webhooks a shocrú

Líon isteach an réimse Ríomhchlár, an réimse Seoladh (URL) nó an dá cheann. Ag gach teagmhas, glaonn an Bosca ar an dá cheann:

Ríomhchlár – comhad .exe, .bat nó .cmd. Glao: ríomhchlár <teagmhas> <param1> <param2> …. Tagann gach luach mar argóint ar leith, fiú má tá spásanna ann. Tosaíonn an ríomhchlár gan fhuinneog, ina fhillteán féin. Tosaíonn tú script PowerShell (.ps1) trí chomhad beag .bat a chur roimhe.
Seoladh (URL) – http nó https, glaoite trí GET: https://do-fhreastalaí/hook?event_type=<teagmhas>&param1=…&param2=…. Tá na luachanna ionchódaithe don URL; fanann paraiméadair atá i do sheoladh cheana féin.

Ní fhanann an seisiún riamh le do webhook: ritheann an ríomhchlár agus an glao taobh leis, agus ní féidir le glao níos mó ná 5 soicind a thógáil. Seolann Seol tástáil session_start láithreach – mar sin seiceálann tú an nasc gan seisiún a thosú.

Ní féidir an ríomhchlár agus an seoladh a shocrú ach go díreach ag an mBosca, ní tríd an Hub: is ceart é cosán ríomhchláir chun rud éigin a rith ar an ríomhaire.

Teagmhais

Teagmhas	Cathain	Paraiméadair
`session_start`	Tosaíonn aoi seisiún, tá an mód socraithe	1: mód (`PrintOnly`, `PrintAndGIF`, `OnlyGIF`, `SlowMoOr360`, `Video`), 2: mód BoothDock (`photo`, `gif`, `boomerang`, `video`, `slowmo`, `ai`)
`countdown_start`	Tosaíonn an comhaireamh síos	1: soicindí
`countdown`	Gach soicind den chomhaireamh síos	1: dul chun cinn mar chéatadán (ó 0)
`capture_start`	Tá an comhaireamh síos thart, tosaíonn an ghabháil	–
`file_download`	Tá grianghraf sábháilte ag an gceamara	1: ainm comhaid, 2: cosán iomlán
`processing_start`	Tosaíonn an phróiseáil	ainm comhaid amháin in aghaidh gach bunleagain ón gceamara, agus mar an luach deireanach an comhad priontála (folamh faoi láthair)
`sharing_screen`	Taispeántar an scáileán torthaí (uair amháin in aghaidh an tseisiúin)	–
`printing`	Téann leathanach chuig printéir	1: comhad (folamh faoi láthair), 2: cóipeanna, 3: printéir
`file_upload`	Tá comhad tagtha chuig an Hub (in aghaidh an chomhaid)	1: cosán ar an mBosca, 2: nasc gailearaí, 3: cineál (`print`, `photo`, `original`, `animation`, `boomerang`, `video`), 4: albam (ainm na hócáide)
`session_end`	Críochnaíonn an seisiún – críochnaithe, curtha ar ceal, imithe in éag nó scriosta	–

Sampla de chomhad .bat a thaifeadann gach teagmhas: echo %DATE% %TIME% %* >> "%~dp0teagmhais.log"

API áitiúil

Rialaíonn ríomhchláir eile an Bosca thar HTTP – mar shampla Stream Deck, do script féin nó rialú 360° ar an bhfón póca.

Cur ar siúl: Córas → Uathoibriú → Cumasaigh an API. De réir réamhshocraithe, tá an API as. Port 1500, inathraithe.
Seoladh: http://localhost:1500/api/<ordú> (nó 127.0.0.1). De réir réamhshocraithe, ní ghlacann an Bosca ach le hiarratais ón ríomhaire seo.
Pasfhocal: 16 charachtar, taispeántar sa rannán céanna é – cóipeáil é nó gin ceann nua. Seol é mar ?password=…, mar cheanntásc X-Api-Password nó mar Authorization: Bearer …. Is é ping an t-aon ordú a oibríonn gan é.
Freagra: HTTP 200 le JSON i gcónaí, mar shampla {"ApiVersion":1,"Command":"cancel","IsSuccessful":true,"ErrorMessage":""}. Léiríonn IsSuccessful ar éirigh leis, agus tugann ErrorMessage an chúis i gcás earráide. Seolann roinnt orduithe Data ar ais freisin.

Glao iomlán: http://localhost:1500/api/start?mode=print&password=DO-PHASFHOCAL

Rialú ón líonra (fón póca, táibléad, 360°)

Cuir Inrochtana ón líonra freisin ar siúl chomh maith. Ansin glacann an Bosca le hiarratais ó ghléasanna ar an Wi-Fi/LAN céanna – ní ón idirlíon choíche.

Seoladh don fhón póca: tá sé sa líne stádais, mar shampla http://192.168.1.20:1500. Taispeánann an sampla faoina bhun an seoladh ceart ansin láithreach.
Gan IP a iontráil: fógraíonn an Bosca é féin ar an líonra (mDNS/Bonjour, cineál seirbhíse _boothdock._tcp, an t-ainm „BoothDock" móide ainm an ríomhaire). Aimsíonn aipeanna a chuardaíonn é go huathoibríoch é.
Bac: má sheolann gléas pasfhocal mícheart deich n-uaire laistigh de dheich nóiméad, cuirtear bac air ar feadh 15 nóiméad. Ní chuirtear bac riamh ar an ríomhaire seo féin.
I do líonra féin amháin: téann an pasfhocal tríd an líonra gan chriptiú. Ná húsáid an mód líonra ach ar do Wi-Fi cosanta féin – ní ar Wi-Fi oscailte na n-aíonna san ionad.
Balla dóiteáin: socraíonn an tsuiteáil an cead, do líonraí príobháideacha amháin. Má thaispeánann an líne stádais rabhadh balla dóiteáin, athshuiteáil BoothDock Studio nó ceadaigh é i Windows faoi „Ceadaigh aip tríd an mballa dóiteáin". Má láimhseálann Windows an Wi-Fi mar líonra poiblí, ní féidir le gléasanna teacht isteach – athraigh an phróifíl go Príobháideach in airíonna an líonra.

Orduithe

Ordú	Éifeacht
`start?mode=print`	Tosaíonn sé seisiún. Móid: `print` (grianghraf), `gif`, `boomerang`, `slowmo` (360°; gan 360°, an Boomerang), `video`, `ai`. Ní oibríonn sé ach ón scáileán tosaigh, le mód cumasaithe amháin agus ní nuair atá an Bosca faoi ghlas.
`cancel`	Cuireann sé an seisiún reatha ar ceal agus filleann sé ar an scáileán tosaigh.
`status`	Tugann sé ar ais in `Data`: mód aoi air/as, an scáileán reatha, mód, faoi ghlas tá/níl.
`print?count=1`	Priontálann sé an toradh deireanach arís (1 go 10 leathanach). Ní féidir físeáin a phriontáil.
`lockscreen/show`	Cuireann sé an Bosca faoi ghlas le „Nóiméad amháin – beimid ar ais láithreach." Fanann cúinne an riarthóra inrochtana.
`lockscreen/exit`	Baineann sé an glas.
`share/email?email=…`	Seolann sé an toradh deireanach trí ríomhphost – teastaíonn nascadh leis an Hub agus an gníomh toraidh “Faigh ar ríomhphost” (Córas → Oibriú → Gníomhartha toraidh (aoi); go dtí leagan 1.4.0, an lasc “Grianghraf trí ríomhphost (aoi)” faoi Dearadh → Scáileáin).
`share/sms`	Níl a leithéid ann; deir an freagra é sin go macánta (`IsSuccessful: false`).
`createtestevent?name=…`	Cruthaíonn sé ócáid tástála agus cuireann sé i ngníomh í. Tá `eventId` agus `eventName` in `Data`. Gan ainm, faigheann sí ainm le dáta.
`deletetestevent?eventId=…`	Scriosann sé ócáid tástála a cruthaíodh tríd an API – ní scriosann sé ócáidí eile riamh.
`ping`	Seiceálann sé, gan pasfhocal, an bhfuil an API ag rith.

Mura bhfreagraíonn an Bosca laistigh de 15 soicind, tagann IsSuccessful: false ar ais le nod.

Easpórtáil fíor-ama

Sa chluaisín céanna, roghnaíonn tú Fillteán easpórtála – mar shampla cuimhneán USB nó fillteán scamall (OneDrive, Dropbox). Sroicheann gach comhad críochnaithe é láithreach, sórtáilte de réir ócáide agus cineáil (priontaí, bunleaganacha, GIFanna, físeáin – is féidir gach ceann a mhúchadh ar leith). Má bhíonn an cuimhneán ar iarraidh ar feadh tamaillín, cóipeálann an Bosca na comhaid níos déanaí. Má scriosann aoi a sheisiún ag an mBosca, imíonn na cóipeanna freisin.

Tosú le cianrialtán

Sa chluaisín céanna, sannann tú eochair faoi Tosú le cianrialtán. De ghnáth seolann cianrialtáin cur i láthair, cnaipí USB agus lasca coise an spásbharra; tá sé sin réamhshocraithe. Faoi Tosaíonn, roghnaíonn tú cad a dhéanann an eochair ar an scáileán tosaigh: Mar thapáil (gnáthshreabhadh) nó mód áirithe láithreach, mar shampla 360° ar an ardán. I BoothDock Studio 1.4.0 agus i leaganacha níos sine, níl an eochair ann ach do 360°, féach 360° / Mallghluaiseacht.

Fabhtcheartú

Ní tharlaíonn faic: an bhfuil aon rud sa loga? Scríobhann webhooks chuig webhooks.log (suas go 1.4.0: ausloeser.log), an API chuig lokale-api.log – an dá cheann san fhillteán %LocalAppData%\Boothdock Studio\logs. Taifeadtar iarratais a diúltaíodh (pasfhocal mícheart, gléas anaithnid) ansin uair amháin sa nóiméad ar a mhéad.
„Invalid password." – cóipeáil an pasfhocal arís; tar éis Pasfhocal nua, ní bhíonn an seancheann bailí a thuilleadh.
„The booth is not on the start screen …" – ní oibríonn start ach ón scáileán tosaigh. cancel ar dtús, ansin start.
„Too many failed attempts …" – sheol an gléas pasfhocal mícheart rómhinic. Fan 15 nóiméad agus seiceáil an pasfhocal.
Ní shroicheann an fón póca an Bosca, ach oibríonn gach rud ar an ríomhaire: is é balla dóiteáin Windows nó Wi-Fi atá marcáilte mar phoiblí is cúis leis beagnach i gcónaí – féach thuas. Tuairiscíonn an líne stádais an dá chás.