Kom i gang
Godkendelse og scopes
Hvert kald har en API-nøgle med. En nøgle når ét arbejdsområde, gør det, dens scopes tillader, og kan udløbe.
Send nøglen
Send nøglen som Bearer-token. Værktøjer, der kun kan udfylde en navngiven header, kan bruge X-Api-Key i stedet; de to er den samme nøgle.
GET /api/v1/events HTTP/1.1
Host: attendbeacon.com
Authorization: Bearer abk_k7m2qx9vtw4p_...En nøgle ser sådan ud: abk_, tolv tegn, en understregning og en hemmelighed på 43. De tolv tegn er dens præfiks: arbejdsområdet viser dem, så du kan skelne nøglerne fra hinanden, og nøglernes aktivitet navngiver nøgler efter dem. Secret scanners genkender mærket abk_, så en nøgle, der ved en fejl er pushet til et repository, er nem at finde.
Der svares kun på HTTPS. Der er ingen cookies og ingen sessioner: hver forespørgsel står alene.
Hvad en nøgle når
En nøgle hører til ét arbejdsområde og når intet andet. Et event, en deltager eller en webhook i et andet arbejdsområde svarer 404, præcis som om det ikke fandtes, så en nøgle kan aldrig finde ud af, hvad en anden arrangør har.
Demonstrationsarbejdsområdet har ingen egne nøgler. Opret dit eget arbejdsområde for at prøve at skrive data; når disse sider læser Beacon Summit, er det demonstrationens rigtige data.
Scopes
Et scope er et område og en adgang: events:read, attendees:write. Giv en nøgle de scopes, dens software har brug for, og ikke mere, så en nøgle, der slipper ud, ikke giver mere væk end det.
- Skriveadgang omfatter læseadgang i samme område: en nøgle med
program:writekan også læse sessioner. people:reader sit eget scope. Uden det er personer id'er: en deltager har en billet, en status og et indtjekningstidspunkt, men intet navn, ingen adresse, virksomhed eller svar, ogpersonalDatasigerwithheld. Optællinger, salg og programmet kræver ingen personer.- Et kald, der kræver et scope, som nøglen mangler, svarer
403med"code": "missingScope"og"scope", der angiver, hvad der mangler. Scopes vælges, når en nøgle oprettes; vil du have andre scopes, så opret en ny nøgle.
| Scope | Giver adgang 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. |
Arbejdsområdet tilbyder fire udgangspunkter: Dashboard (events, billetter, ordrer, indtjekninger og programmet, kun læsning), Power Automate eller Zapier (det, connectoren og Zapier-appen bruger), AI-assistent (alt til læsning, personer inklusive) og Alt.
Nøgler oprettet før oktober 2026
Nøgler fra før scopes pr. område havde read og write. De er skrevet om til det, de betød, og virker præcis som før: read blev til alle de læseadgange, der fandtes (personer inklusive), write blev til attendees:write og checkins:write. Intet har fået nye beføjelser.
Udløb og tilbagekaldelse
En nøgle kan udløbe efter 30, 90, 180 eller 365 dage, eller aldrig. En udløbet nøgle svarer 401 med "code": "keyExpired"; opret den nye nøgle inden den gamles dato, og skift den ind, så stopper intet.
Tilbagekalder du en nøgle i arbejdsområdet, stopper den med det samme (keyRevoked). De Power Automate-flows og Zaps, den har abonneret på, afmeldes sammen med den, fordi de ikke længere selv kan afmelde sig.
Nøglernes aktivitet
Integrationer › API & MCP › Nøglernes aktivitet viser alle kald, en nøgle har foretaget via API'et eller MCP-serveren de seneste 90 dage: hvornår, hvilken operation (ruten, fx GET /events/{eventId}/attendees, eller MCP-værktøjet), hvordan der blev svaret, hvor lang tid det tog, og fra hvilken adresse. Aldrig en query string, en body eller et svar: en deltagers adresse i en søgning hører ikke hjemme i en log. Afviste kald er der også, med deres kode, så det er det første sted, du skal kigge efter missingScope eller rateLimited, når et flow stopper.
Ændringer foretaget med en nøgle vises også i arbejdsområdets aktivitetslog, navngivet efter nøglen: "API key abk_k7m2qx9vtw4p (Attendee sync for the CRM)".
Pas på dine nøgler
- Én nøgle pr. stykke software, opkaldt efter det, så du kan tilbagekalde én uden at stoppe de andre.
- Opbevar nøgler i et hemmelighedslager (Key Vault, din CI's secrets, en adgangskodeadministrator), aldrig i kode eller i et repository.
- Send aldrig en nøgle til en browser. Prøv det-knappen i denne dokumentation er den undtagelse, du selv vælger: nøglen bliver i sidens hukommelse og sendes kun til attendbeacon.com.
- Giv nøgler en udløbsdato, og tilbagekald dem, som aktivitetslisten viser, at ingen bruger.