Kom i gang
Autentisering og omfang
Hvert kall har med seg en API-nøkkel. En nøkkel når ett arbeidsområde, gjør det omfangene tillater, og kan utløpe.
Slik sender du nøkkelen
Send nøkkelen som et Bearer-token. Verktøy som bare kan fylle ut en navngitt header, kan bruke X-Api-Key i stedet; begge er den samme nøkkelen.
GET /api/v1/events HTTP/1.1
Host: attendbeacon.com
Authorization: Bearer abk_k7m2qx9vtw4p_...En nøkkel består av abk_, tolv tegn, en understrek og en hemmelighet på 43 tegn. De tolv tegnene er prefikset: arbeidsområdet viser dem slik at du kan skille nøklene fra hverandre, og nøklenes aktivitet navngir nøklene etter dem. Verktøy som leter etter hemmeligheter, kjenner igjen merket abk_, så en nøkkel som ved et uhell er sendt til et repository, er lett å finne.
Det svares bare på HTTPS. Det finnes ingen informasjonskapsler og ingen økter: hver forespørsel står for seg selv.
Hva en nøkkel når
En nøkkel tilhører ett arbeidsområde og når ingenting annet. Et arrangement, en deltaker eller en webhook i et annet arbeidsområde svarer 404, nøyaktig som om det ikke fantes, så en nøkkel kan aldri finne ut hva en annen arrangør har.
Demonstrasjonsarbeidsområdet har ingen egne nøkler. Opprett ditt eget arbeidsområde for å prøve skriving; lesingene av Beacon Summit i denne dokumentasjonen er demonstrasjonens ekte data.
Omfang
Et omfang er et område og en tilgang: events:read, attendees:write. Gi en nøkkel de omfangene programvaren trenger og ikke mer, så en nøkkel som lekker, ikke gir bort mer enn det.
- Endre inkluderer lese innenfor samme område: en nøkkel med
program:writekan også lese økter. people:reader et eget omfang. Uten det er personer ID-er: en deltaker har en billett, en status og et innsjekkingstidspunkt, men ikke navn, adresse, firma eller svar, ogpersonalDatasierwithheld. Tall, salg og programmet trenger ingen person.- Et kall som krever et omfang nøkkelen mangler, svarer
403med"code": "missingScope"og"scope"som navngir det som mangler. Omfangene velges når en nøkkel opprettes; trenger du andre omfang, oppretter du en ny nøkkel.
| Omfang | Gir tilgang til |
|---|---|
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. |
Arbeidsområdet tilbyr fire utgangspunkt: Dashbord (arrangementer, billetter, bestillinger, innsjekkinger og programmet, bare lesing), Power Automate eller Zapier (det koblingen og Zapier-appen bruker), KI-assistent (alt for lesing, personer inkludert) og Alt.
Nøkler opprettet før oktober 2026
Nøkler fra før omfang per område hadde read og write. De ble skrevet om til det de betydde, og virker nøyaktig som før: read ble all lesing som fantes (personer inkludert), write ble attendees:write og checkins:write. Ingen fikk nye rettigheter.
Utløp og tilbakekalling
En nøkkel kan utløpe etter 30, 90, 180 eller 365 dager, eller aldri. En utløpt nøkkel svarer 401 med "code": "keyExpired"; opprett den nye nøkkelen før den gamle utløper og bytt den inn, så stopper ingenting.
Når du tilbakekaller en nøkkel i arbeidsområdet, slutter den å virke med en gang (keyRevoked). Power Automate-flytene og Zap-ene den abonnerte for, avsluttes sammen med den, fordi de ikke lenger kan avslutte abonnementet selv.
Nøklenes aktivitet
Integrasjoner › API & MCP › Nøklenes aktivitet viser hvert kall en nøkkel har gjort via API-et eller MCP-serveren de siste 90 dagene: når, hvilken operasjon (ruten, for eksempel GET /events/{eventId}/attendees, eller MCP-verktøyet), hvordan det ble besvart, hvor lang tid det tok og fra hvilken adresse. Aldri en spørrestreng, et innhold eller et svar: en deltakers adresse i et søk skal ikke ligge i en logg. Avviste kall er også med, med koden sin, så missingScope eller rateLimited er det første stedet å se når en flyt stopper.
Endringer gjort med en nøkkel vises også i arbeidsområdets aktivitetslogg, navngitt etter nøkkelen: «API key abk_k7m2qx9vtw4p (Attendee sync for the CRM)».
Hold nøklene trygge
- Én nøkkel per programvare, navngitt etter den, så du kan tilbakekalle én uten å stoppe de andre.
- Oppbevar nøkler i et hemmelighetslager (Key Vault, CI-systemets hemmeligheter, en passordbehandler), aldri i kode eller i et repository.
- Send aldri en nøkkel til en nettleser. Prøv det-knappen i denne dokumentasjonen er unntaket du gjør selv: nøkkelen blir i sidens minne og går bare til attendbeacon.com.
- Gi nøklene en utløpsdato, og tilbakekall dem som aktivitetslisten viser at ingen bruker.