← L-artikli kollha

BoothDock · Wiki

Webhooks u API

BoothDock Studio jista' jinforma programmi oħra dwar kull pass ta' sessjoni (Webhooks) u jħalli lil programmi oħra jikkontrollawh (API lokali). Issib it-tnejn fit-taqsima tal-amministrazzjoni taħt Sistema → Awtomazzjoni.

F'BoothDock Studio 1.4.0 u f'verżjonijiet eqdem, il-webhooks hemmhekk għadhom jissejħu “Triggers”.

Il-webhooks u l-esportazzjoni f'ħin reali jeżistu biss fuq Windows. L-API lokali hija disponibbli mill-verżjoni 1.4.0 ukoll fuq iPad u iPhone.

Użi tipiċi: dawl jew DMX skont il-countdown, overlay għal stream, counter fid-daħla – jew Stream Deck bħala remote control għall-box.

Sistema → Awtomazzjoni: esportazzjoni f'ħin reali, webhooks u API lokali
Sistema → Awtomazzjoni: esportazzjoni f'ħin reali, webhooks u API lokali

Kif tissettja l-webhooks

Imla Programm, Indirizz (URL) jew it-tnejn. F'kull ġrajja l-box issejjaħ lit-tnejn:

  • Programm – .exe, .bat jew .cmd. Sejħa: programm <ġrajja> <param1> <param2> …. Kull valur jasal bħala argument separat, anke jekk ikun fih spazji. Il-programm jibda mingħajr tieqa, fil-folder tiegħu stess. Script tal-PowerShell (.ps1) tibdih permezz ta' .bat żgħir li jsejjaħlu.
  • Indirizz (URL) – http jew https, imsejjaħ permezz ta' GET: https://is-server-tiegħek/hook?event_type=<ġrajja>&param1=…&param2=…. Il-valuri huma URL-encoded; parametri li diġà jinsabu fl-indirizz tiegħek jibqgħu.

Is-sessjoni qatt ma tistenna l-webhook tiegħek: il-programm u s-sejħa jaħdmu b'mod parallel, sejħa tista' ddum l-aktar 5 sekondi. Ibgħat test jibgħat minnufih session_start – hekk tivverifika l-konnessjoni mingħajr ma tibda sessjoni.

Il-programm u l-indirizz jistgħu jiġu ssettjati biss direttament fuq il-box, mhux permezz tal-Hub: path ta' programm huwa dritt li tħaddem xi ħaġa fuq il-kompjuter.

Ġrajjiet

ĠrajjaMetaParametri
session_startMistieden jibda sessjoni, il-modalità hija stabbilita1: modalità (PrintOnly, PrintAndGIF, OnlyGIF, SlowMoOr360, Video), 2: modalità BoothDock (photo, gif, boomerang, video, slowmo, ai)
countdown_startIl-countdown jibda1: sekondi
countdownKull sekonda tal-countdown1: progress f'perċentwal (minn 0)
capture_startIl-countdown spiċċa, it-teħid jibda–
file_downloadIl-kamera ħażnet ritratt1: isem il-fajl, 2: path sħiħ
processing_startL-ipproċessar jibdaisem ta' fajl għal kull oriġinal tal-kamera, bħala l-aħħar valur il-fajl tal-istampar (bħalissa vojt)
sharing_screenL-iskrin tar-riżultat jidher (darba għal kull sessjoni)–
printingFolja tintbagħat lil stampatur1: fajl (bħalissa vojt), 2: kopji, 3: stampatur
file_uploadFajl wasal fil-Hub (għal kull fajl)1: path fuq il-box, 2: link tal-galerija, 3: tip (print, photo, original, animation, boomerang, video), 4: album (isem l-avveniment)
session_endIs-sessjoni tispiċċa – lesta, ikkanċellata, skaduta jew imħassra–

Eżempju ta' .bat li jirreġistra kull ġrajja: echo %DATE% %TIME% %* >> "%~dp0grajjiet.log"

API lokali

Programmi oħra jikkontrollaw il-box permezz ta' HTTP – pereżempju Stream Deck, script tiegħek jew kontroll 360° fuq il-mowbajl.

  • Xgħel: Sistema → Awtomazzjoni → Ixgħel l-API. Mill-fabbrika l-API hija mitfija. Port 1500, jista' jinbidel.
  • Indirizz: http://localhost:1500/api/<kmand> (jew 127.0.0.1). Mill-fabbrika l-box taċċetta talbiet biss minn dan il-kompjuter.
  • Password: 16-il karattru, murija fl-istess taqsima – ikkopjaha jew iġġenera waħda ġdida. Ibgħatha bħala ?password=…, bħala header X-Api-Password jew bħala Authorization: Bearer …. ping biss jaħdem mingħajrha.
  • Tweġiba: dejjem HTTP 200 b'JSON, pereżempju {"ApiVersion":1,"Command":"cancel","IsSuccessful":true,"ErrorMessage":""}. Jekk irnexxiex jidher f'IsSuccessful, ir-raġuni f'każ ta' żball f'ErrorMessage. Xi kmandi jagħtu wkoll Data.

Sejħa sħiħa: http://localhost:1500/api/start?mode=print&password=IL-PASSWORD-TIEGĦEK

Kontroll min-netwerk (mowbajl, tablet, 360°)

Ixgħel ukoll Aċċessibbli wkoll min-netwerk. Imbagħad il-box taċċetta talbiet minn apparati fl-istess Wi-Fi/LAN – qatt mill-internet.

  • Indirizz għall-mowbajl: jidher fil-linja tal-istatus, pereżempju http://192.168.1.20:1500. L-eżempju ta' taħtha mbagħad juri minnufih l-indirizz it-tajjeb.
  • Mingħajr ma ddaħħal l-IP: il-box tħabbar lilha nfisha fin-netwerk (mDNS/Bonjour, tip ta' servizz _boothdock._tcp, isem „BoothDock" flimkien mal-isem tal-kompjuter). L-apps li jfittxu għaliha jsibuha awtomatikament.
  • Imblokkar: jekk apparat jibgħat password ħażina għaxar darbiet f'għaxar minuti, jiġi mblukkat għal 15-il minuta. Dan il-kompjuter innifsu qatt ma jiġi mblukkat.
  • Biss fin-netwerk tiegħek: il-password tgħaddi min-netwerk mhux kriptata. Uża t-tħaddim min-netwerk biss fil-Wi-Fi protett tiegħek – mhux fil-Wi-Fi miftuħ għall-mistednin tal-post.
  • Firewall: l-installazzjoni tissettja l-permess, biss għal netwerks privati. Jekk il-linja tal-istatus turi twissija tal-firewall, erġa' installa BoothDock Studio jew ippermettih f'Windows taħt „Ippermetti app permezz tal-firewall". Jekk Windows jittratta l-Wi-Fi bħala pubbliku, l-apparati ma jidħlux – fil-proprjetajiet tan-netwerk issettja l-profil għal Privat.

Kmandi

KmandEffett
start?mode=printJibda sessjoni. Modi: print (ritratt), gif, boomerang, slowmo (360°; mingħajr 360°, il-boomerang), video, ai. Jaħdem biss mill-iskrin tal-bidu, biss b'modalità attivata u mhux meta l-box tkun imsakkra.
cancelJikkanċella s-sessjoni li għaddejja u jmur lura għall-iskrin tal-bidu.
statusJagħti f'Data: modalità tal-mistieden mixgħula/mitfija, skrin attwali, modalità, imsakkra iva/le.
print?count=1Jerġa' jistampa l-aħħar riżultat (minn 1 sa 10 folji). Il-videos ma jistgħux jiġu stampati.
lockscreen/showIsakkar il-box b'„Mument – nkomplu dalwaqt." Il-kantuniera tal-admin tibqa' aċċessibbli.
lockscreen/exitIneħħi s-serratura.
share/email?email=…Jibgħat l-aħħar riżultat bl-email – jeħtieġ il-konnessjoni mal-Hub u l-azzjoni tar-riżultat “Ikseb via email” (Sistema → Tħaddim → Azzjonijiet tar-riżultat (mistieden); sal-verżjoni 1.4.0, is-swiċċ “Ritratt bl-email (mistieden)” taħt Disinn → Skrins).
share/smsMa jeżistix; it-tweġiba tgħid dan b'onestà (IsSuccessful: false).
createtestevent?name=…Joħloq avveniment tat-test u jagħmlu attiv. Data fih eventId u eventName. Mingħajr isem jingħata wieħed bid-data.
deletetestevent?eventId=…Iħassar avveniment tat-test li nħoloq permezz tal-API – qatt avvenimenti oħra.
pingJivverifika mingħajr password jekk l-API hijiex taħdem.

Jekk il-box ma twieġibx fi żmien 15-il sekonda, jiġi lura IsSuccessful: false b'nota.

Esportazzjoni f'ħin reali

Fl-istess tab tagħżel Folder tal-esportazzjoni – pereżempju USB stick jew folder fil-cloud (OneDrive, Dropbox). Kull fajl lest jasal hemm minnufih, organizzat skont l-avveniment u t-tip (stampi, oriġinali, GIFs, videos – kull wieħed jista' jintefa separatament). Jekk l-istick ikun nieqes għal ftit, il-box tikkopja l-fajls aktar tard. Jekk mistieden iħassar is-sessjoni tiegħu fuq il-box, jisparixxu wkoll il-kopji.

Ibda bir-remote

Fl-istess tab tgħallem buttuna taħt Ibda bir-remote. Il-presenters, il-buttuni USB u s-swiċċijiet tas-sieq normalment jibagħtu l-buttuna tal-ispazju; din hija ssettjata minn qabel. Taħt Jibda tagħżel x'tagħmel il-buttuna fuq l-iskrin tal-bidu: Bħal mess (fluss normali) jew direttament modalità partikolari, pereżempju l-360° fuq il-pjattaforma. F'BoothDock Studio 1.4.0 u f'verżjonijiet eqdem, il-buttuna teżisti biss għall-360°, ara 360° / Slow motion.

Soluzzjoni ta' problemi

  • Ma jiġri xejn: hemm xi ħaġa fil-log? Il-webhooks jiktbu f'webhooks.log (sa 1.4.0: ausloeser.log), l-API f'lokale-api.log – it-tnejn fil-folder %LocalAppData%\Boothdock Studio\logs. Talbiet miċħuda (password ħażina, apparat barrani) jidhru hemm l-aktar darba kull minuta.
  • „Invalid password." – erġa' kkopja l-password; wara Password ġdida dik il-qadima ma tibqax valida.
  • „The booth is not on the start screen …" – start jaħdem biss mill-iskrin tal-bidu. L-ewwel cancel, imbagħad start.
  • „Too many failed attempts …" – l-apparat bagħat password ħażina wisq drabi. Stenna 15-il minuta u ċċekkja l-password.
  • Il-mowbajl ma jilħaqx il-box, fuq il-kompjuter kollox jaħdem: kważi dejjem il-firewall ta' Windows jew Wi-Fi ttrattat bħala pubbliku – ara hawn fuq. Il-linja tal-istatus tirrapporta ż-żewġ każijiet.

Il-passi li jmiss