← Alla artiklar

BoothDock · Wiki

Webhooks och API

BoothDock Studio kan informera andra program om varje steg i en session (webhooks) och låta sig styras av andra program (lokalt API). Båda hittar du i adminområdet under System → Automatisering.

I BoothDock Studio 1.4.0 och tidigare versioner heter webhooks där fortfarande ”Utlösare”.

Webhooks finns under Windows och från version 1.5.10 även på iPad, iPhone och Mac. Det lokala API:t finns från version 1.4.0 även på iPad, iPhone och Mac, realtidsexporten från version 1.5.2.

Typiska användningar: ljus eller DMX i takt med nedräkningen, ett stream-overlay, en räknare vid entrén – eller ett Stream Deck som fjärrkontroll för boxen.

System → Automatisering: realtidsexport, webhooks och lokalt API
System → Automatisering: realtidsexport, webhooks och lokalt API

Ställa in webhooks

Fyll i fältet Adress (URL), under Windows även fältet Program – eller båda. Vid varje händelse anropar boxen allt som är ifyllt:

  • Program (endast Windows) – en .exe, .bat eller .cmd. Anrop: program <händelse> <param1> <param2> …. Varje värde kommer fram som ett eget argument, även om det innehåller mellanslag. Programmet startar utan fönster, i sin egen mapp. Ett PowerShell-skript (.ps1) startar du via en liten .bat framför.
  • Adress (URL) – http eller https, anropad med GET: https://din-server/hook?event_type=<händelse>&param1=…&param2=…. Värdena är URL-kodade; parametrar som redan finns i din adress behålls.

På iPad, iPhone och Mac finns bara adressen. Där fungerar http:// bara i det lokala nätverket (IP-adress eller .local) – Shelly, WLED och Tasmota på wifi fungerar alltså. Adresser på internet behöver https://.

Sessionen väntar aldrig på din webhook: program och anrop körs vid sidan av, och ett anrop får ta högst 5 sekunder. Skicka test skickar direkt ett session_start – så kontrollerar du anslutningen utan att starta en session.

Program och adress kan bara ställas in direkt på boxen, inte via Hub: en programsökväg är en rättighet att köra något på datorn.

Egen adress per händelse

Från version 1.5.10 kan du under Egen adress per händelse (valfritt) ge varje händelse en egen adress utöver den vanliga – till exempel för ett Shelly-uttag, WLED eller Tasmota på wifi som slår om vid nedräkningen eller vid fotograferingen. Exempel för countdown_start: http://192.168.1.50/relay/0?turn=on.

Boxen anropar den här adressen utöver programmet och adressen ovan, som en enkel GET utan tillagda värden. Den tidigare adressen och befintliga skript fungerar oförändrat. countdown kommer varje sekund; vid file_upload anropar boxen den egna adressen en gång per session (den allmänna adressen fortfarande per fil).

Händelser

HändelseNärParametrar
session_startEn gäst startar en session, läget är bestämt1: läge (PrintOnly, PrintAndGIF, OnlyGIF, SlowMoOr360, Video), 2: BoothDock-läge (photo, gif, boomerang, video, slowmo, ai)
countdown_startNedräkningen börjar1: sekunder
countdownVarje sekund av nedräkningen1: förlopp i procent (från 0)
capture_startNedräkningen är klar, tagningen börjar–
file_downloadKameran har sparat ett foto1: filnamn, 2: fullständig sökväg
processing_startBearbetningen börjarett filnamn per kameraoriginal, som sista värde utskriftsfilen (för närvarande tom)
sharing_screenResultatskärmen visas (en gång per session)–
printingEtt ark skickas till en skrivare1: fil (för närvarande tom), 2: kopior, 3: skrivare
file_uploadEn fil har kommit fram till Hub (per fil)1: sökväg på boxen, 2: gallerilänk, 3: typ (print, photo, original, animation, boomerang, video), 4: album (eventnamn)
lead_submittedEn gäst har skickat formuläret Gästdata (formulär) (från 1.5.0)– (själva svaren finns bara i CSV-exporten)
session_endSessionen avslutas – klar, avbruten, utgången eller raderad–

Exempel på en .bat som loggar varje händelse: echo %DATE% %TIME% %* >> "%~dp0handelser.log"

Lokalt API

Andra program styr boxen via HTTP – till exempel ett Stream Deck, ett eget skript eller en 360°-styrning på mobilen.

  • Slå på: System → Automatisering → Aktivera API. Från fabrik är API:t avstängt. Port 1500, kan ändras.
  • Adress: http://localhost:1500/api/<kommando> (eller 127.0.0.1). Från fabrik tar boxen bara emot förfrågningar från den här datorn.
  • Lösenord: 16 tecken, visas i samma avsnitt – kopiera det eller skapa ett nytt. Skicka med det som ?password=…, som rubrik X-Api-Password eller som Authorization: Bearer …. Bara ping fungerar utan.
  • Svar: alltid HTTP 200 med JSON, till exempel {"ApiVersion":1,"Command":"cancel","IsSuccessful":true,"ErrorMessage":""}. Om det lyckades står i IsSuccessful, orsaken vid fel i ErrorMessage. Vissa kommandon levererar dessutom Data.

Ett fullständigt anrop: http://localhost:1500/api/start?mode=print&password=DITT-LÖSENORD

Styra från nätverket (mobil, surfplatta, 360°)

Slå dessutom på Nås även från nätverket. Då tar boxen emot förfrågningar från enheter i samma Wi-Fi/LAN – aldrig från internet.

  • Adress för mobilen: står i statusraden, till exempel http://192.168.1.20:1500. Exemplet under visar då direkt rätt adress.
  • Utan att ange IP: boxen anmäler sig själv i nätverket (mDNS/Bonjour, tjänsttyp _boothdock._tcp, namn ”BoothDock” plus datornamnet). Appar som söker efter den hittar den automatiskt.
  • Spärr: skickar en enhet fel lösenord tio gånger på tio minuter spärras den i 15 minuter. Boxens egen dator spärras aldrig.
  • Bara i ditt eget nätverk: lösenordet skickas okrypterat över nätverket. Använd nätverksläget bara i ditt eget, skyddade Wi-Fi – inte i lokalens öppna gäst-Wi-Fi.
  • Brandvägg: installationen skapar regeln, bara för privata nätverk. Visar statusraden en brandväggsvarning, installera om BoothDock Studio eller tillåt det i Windows under ”Tillåt en app genom brandväggen”. Behandlar Windows ditt Wi-Fi som offentligt kommer enheter inte in – ändra profilen till Privat i nätverksegenskaperna.

Kommandon

KommandoVerkan
start?mode=printStartar en session. Lägen: print (foto), gif, boomerang, slowmo (360°; utan 360° boomerangen), video, ai. Fungerar bara från startskärmen, bara med ett aktiverat läge och inte när boxen är spärrad. Med mall, stil och bakgrund: se nedan.
auswahl?mode=printLevererar i Data vad som finns att välja för det här läget: vorlagen (Id och namn; tom om bara en mall är frisläppt – den står då i vorgabeVorlage), hintergruende per mall och i läget ai även stile (från 1.5.13).
cancelAvbryter den pågående sessionen och går tillbaka till startskärmen.
statusLevererar i Data: gästläge på/av, aktuell skärm, läge, spärrad ja/nej – från 1.5.13 även sperrgrund (manuell eller zeitfenster) och oeffnetUm.
print?count=1Skriver ut det senaste resultatet en gång till (1 till 10 ark). Videor kan inte skrivas ut.
lockscreen/showSpärrar boxen med ”Ett ögonblick – strax fortsätter vi.” eller din egen text och bild (se ”Låsskärm” nedan). Adminhörnet förblir nåbart. Från 1.5.13 består spärren även efter en omstart av appen.
lockscreen/exitHäver spärren – från 1.5.13 även spärren via tidsfönstret, fram till nästa växling.
share/email?email=…Skickar det senaste resultatet via e-post – kräver kopplingen till Hub och resultatåtgärden ”Skicka via e-post” (System → Drift → Resultatåtgärder (gäst); till och med 1.4.0 reglaget ”Foto via e-post (gäst)” under Design → Skärmar).
share/smsFinns inte; svaret säger det ärligt (IsSuccessful: false).
createtestevent?name=…Skapar ett testevent och gör det aktivt. Data innehåller eventId och eventName. Utan namn får det ett namn med datum. Endast utanför gästläget (från 1.5.4).
deletetestevent?eventId=…Raderar ett testevent som skapats via API:t – aldrig andra event. Endast utanför gästläget (från 1.5.4).
pingKontrollerar utan lösenord om API:t körs.

Svarar boxen inte inom 15 sekunder kommer IsSuccessful: false tillbaka med en hänvisning.

Starta en session med mall, stil och bakgrund

Från version 1.5.13 tar start med valet direkt – boxen hoppar då över just dessa valskärmar:

  • vorlage=<Id> (eller template=) – mallen, bara i läget print (foto). Id:na får du med auswahl?mode=print.
  • stil=<Id> (eller style=) – AI-stilen, bara i läget ai.
  • hintergrund=<Id> (eller background=) – bakgrunden för frilägningen, som passar mallen.

Exempel: http://localhost:1500/api/start?mode=print&vorlage=hochzeit-gold&hintergrund=strand&password=DITT-LÖSENORD

Ett okänt eller icke passande Id startar ingen session: IsSuccessful är false, ErrorMessage anger orsaken. Samtycke till dataskydd och formuläret för gästdata visar boxen fortfarande själv – de gäller gästen framför boxen och kan inte göras i förväg via API:et.

Låsskärm

Under Event → Låsskärm (från 1.5.13) bestämmer du vad en spärrad box visar: egen text, egen bild och – vid tidsfönster – en stor nedräkning till öppningen.

  • Tidsfönster per event: Med Öppnar kl. och Stänger kl. är boxen spärrad före start och efter slut.
  • Lås upp på enheten: Om en operatörs-PIN är inställd (System → Skydd) visar spärrskärmen ett litet hänglås. Den som kan PIN-koden låser upp boxen. Upplåst före start förblir den öppen till slut.
  • På distans: I Hub under Bås spärrar och låser du upp varje box som stöder det (Studio från 1.5.13). Detsamma fungerar via BoothDock Station och med lockscreen/show / lockscreen/exit.

En pågående session avbryts varken av spärren från Hub eller av tidsfönstret – boxen spärras så snart gästen är klar.

Realtidsexport

På samma flik: varje färdig fil hamnar direkt på själva boxen (Lokal kopia) – även utan Hub, sorterad efter event och typ (utskrifter, original, GIF, videor – kan stängas av var för sig). Den här kopian raderas aldrig automatiskt. Under USB-minne / andra mapp lägger du till ett andra mål: Skriv automatiskt till USB-minne skriver till varje isatt minne, Hämta ikapp missade filer skriver i efterhand det som skapades utan minne. Alternativt anger du en Fast andra mapp (har företräde), till exempel en molnmapp (OneDrive, Dropbox). Raderar en gäst sin session vid boxen försvinner även kopiorna. På iPad och iPhone: I appen Filer under ”På min iPad › BoothDock Studio › Export”. I BoothDock Studio 1.5.3 och äldre finns i stället bara Exportmapp.

Start med fjärrkontroll

På samma flik lär du in en tangent under Start med fjärrkontroll. Presentationsfjärrkontroller, USB-knappar och fotpedaler skickar oftast mellanslag; det är förinställt. Vid Startar väljer du vad tangenten gör på startskärmen: Som vid beröring (normalt flöde) eller direkt ett läge, till exempel 360° på plattformen. I BoothDock Studio 1.4.0 och tidigare versioner finns tangenten bara för 360°, se 360° / slowmotion.

Felsökning

  • Inget händer: står något i loggen? Webhooks skriver till webhooks.log (till och med 1.4.0: ausloeser.log), API:t till lokale-api.log – båda i mappen %LocalAppData%\Boothdock Studio\logs (Windows). Avvisade förfrågningar (fel lösenord, främmande enhet) står där högst en gång per minut.
  • ”Invalid password.” – kopiera lösenordet på nytt; efter Nytt lösenord gäller det gamla inte längre.
  • ”The booth is not on the start screen …” – start fungerar bara från startskärmen. Först cancel, sedan start.
  • ”Too many failed attempts …” – enheten har skickat fel lösenord för många gånger. Vänta 15 minuter och kontrollera lösenordet.
  • Mobilen når inte boxen, men på datorn fungerar allt: nästan alltid Windows-brandväggen eller ett Wi-Fi som behandlas som offentligt – se ovan. Båda fallen visas i statusraden.

Nästa steg