Kom igång
Autentisering och behörigheter
Varje anrop har med sig en API-nyckel. En nyckel når en arbetsyta, gör det dess behörigheter tillåter och kan upphöra.
Skicka nyckeln
Skicka nyckeln som en Bearer-token. Verktyg som bara kan fylla i ett namngivet huvud kan använda X-Api-Key i stället; det är samma nyckel.
GET /api/v1/events HTTP/1.1
Host: attendbeacon.com
Authorization: Bearer abk_k7m2qx9vtw4p_...En nyckel består av abk_, tolv tecken, ett understreck och en hemlighet på 43 tecken. De tolv tecknen är dess prefix: arbetsytan visar dem så att du kan skilja nycklar åt, och nycklarnas aktivitet namnger nycklar med dem. Verktyg som söker efter hemligheter känner igen markören abk_, så en nyckel som av misstag hamnat i ett repository är lätt att hitta.
Bara HTTPS besvaras. Det finns inga cookies och inga sessioner: varje anrop står för sig självt.
Vad en nyckel når
En nyckel hör till en arbetsyta och når inget annat. Ett evenemang, en deltagare eller en webhook i en annan arbetsyta svarar 404, precis som om den inte fanns, så en nyckel kan aldrig ta reda på vad en annan arrangör har.
Demonstrationsarbetsytan har inga egna nycklar. Skapa en egen arbetsyta för att prova skrivningar; läsningar av Beacon Summit i den här dokumentationen är demonstrationens verkliga data.
Behörigheter
En behörighet (scope) är ett område och en åtkomst: events:read, attendees:write. Ge en nyckel de behörigheter som programvaran behöver och inget mer, så att en nyckel som läcker inte avslöjar mer än så.
- Skriva innefattar läsa inom samma område: en nyckel med
program:writekan också läsa sessioner. people:readär en egen behörighet. Utan den är personer id:n: en deltagare har en biljett, en status och en incheckningstid, men inget namn, ingen adress, inget företag och inga svar, ochpersonalDatasägerwithheld. Antal, försäljning och programmet behöver inga personer.- Ett anrop som kräver en behörighet som nyckeln saknar svarar
403med"code": "missingScope", och"scope"anger vad som saknas. Behörigheter väljs när en nyckel skapas; för andra behörigheter skapar du en ny nyckel.
| Behörighet | Tillåter |
|---|---|
events:read | Events: the list, details, statistics, registration questions and doors. |
events:write | Create draft events, change their basics and publish or unpublish them. |
tickets:read | Ticket types, add-ons and discount codes, with what is sold. |
tickets:write | Change a ticket type's capacity and sales window, and create discount codes. |
orders:read | Orders and their money, and the sales pace. |
attendees:read | Registrations and attendees: ticket, status and check-in; names and answers need people:read too. |
attendees:write | Register people with a free ticket and cancel tickets, as the workspace does. |
checkins:read | Door scans and check-in counts. |
checkins:write | Check attendees in at a door, by the scanner's rules. |
program:read | Sessions, rooms, tracks and speakers. |
program:write | Add and change sessions on the agenda. |
sponsors:read | Sponsors, exhibitors, their levels and consented leads. |
cfp:read | Call-for-speakers submissions and their status. |
crew:read | Crew, volunteers, roles and shifts. |
surveys:read | Surveys, session ratings and their results, never who answered. |
finance:read | Invoices, credit notes and the budget summary. |
sharekit:read | The share kit's leaderboard of speakers, sponsors and attendees who spread the word. |
communities:read | Communities and their members. |
webhooks:read | Webhook endpoints, their deliveries, the event types and subscriptions for automation platforms. |
webhooks:write | Add, change, test and remove webhook endpoints. |
people:read | Personal data in any of the above: names, email addresses, companies and answers. Without it, people are ids only. |
Arbetsytan erbjuder fyra utgångspunkter: Instrumentpanel (evenemang, biljetter, beställningar, incheckningar och programmet, endast läsning), Power Automate eller Zapier (det som anslutningen och Zapier-appen använder), AI-assistent (allt för läsning, personer inräknade) och Allt.
Nycklar skapade före oktober 2026
Nycklar från tiden före behörigheter per område hade read och write. De har skrivits om till vad de betydde och fungerar precis som förut: read blev alla läsbehörigheter som fanns (personer inräknade), write blev attendees:write och checkins:write. Ingen nyckel fick nya befogenheter.
Utgång och återkallande
En nyckel kan upphöra efter 30, 90, 180 eller 365 dagar, eller aldrig. En nyckel som har upphört svarar 401 med "code": "keyExpired"; skapa den nya nyckeln före den gamlas sista dag och byt, så stannar ingenting.
Om du återkallar en nyckel i arbetsytan slutar den fungera direkt (keyRevoked). De Power Automate-flöden och Zaps som den prenumererade åt avslutas samtidigt, eftersom de inte längre själva kan avsluta sin prenumeration.
Nycklarnas aktivitet
Integrationer › API & MCP › Nycklarnas aktivitet listar varje anrop som en nyckel har gjort via API:t eller MCP-servern de senaste 90 dagarna: när, vilken operation (vägen, till exempel GET /events/{eventId}/attendees, eller MCP-verktyget), hur den besvarades, hur lång tid det tog och från vilken adress. Aldrig en frågesträng, en brödtext eller ett svar: en deltagares adress i en sökning ska inte ligga kvar i en logg. Avvisade anrop finns också där, med sin kod, så missingScope eller rateLimited är det första stället att titta på när ett flöde stannar.
Ändringar som görs med en nyckel syns också i arbetsytans aktivitetslogg, namngivna efter nyckeln: ”API key abk_k7m2qx9vtw4p (Attendee sync for the CRM)”.
Håll nycklarna säkra
- En nyckel per programvara, namngiven efter den, så att du kan återkalla en utan att stoppa de andra.
- Förvara nycklar i ett hemlighetslager (Key Vault, din CI:s hemligheter, en lösenordshanterare), aldrig i kod eller i ett repository.
- Skicka aldrig en nyckel till en webbläsare. Prova-knappen i den här dokumentationen är undantaget som du själv väljer: nyckeln stannar i sidans minne och går bara till attendbeacon.com.
- Ge nycklar ett utgångsdatum, och återkalla de nycklar som aktivitetslistan visar att ingen använder.