Aan de slag
Authenticatie en scopes
Elke aanroep heeft een API-sleutel bij zich. Een sleutel bereikt één werkruimte, doet wat zijn scopes toestaan en kan verlopen.
De sleutel meesturen
Stuur de sleutel mee als Bearer-token. Tools die alleen een header met een eigen naam kunnen vullen, mogen in plaats daarvan X-Api-Key gebruiken; het is dezelfde sleutel.
GET /api/v1/events HTTP/1.1
Host: attendbeacon.com
Authorization: Bearer abk_k7m2qx9vtw4p_...Een sleutel bestaat uit abk_, twaalf tekens, een underscore en een geheim van 43 tekens. Die twaalf tekens zijn het voorvoegsel: de werkruimte toont ze zodat je sleutels uit elkaar houdt, en de activiteit van sleutels noemt sleutels erbij. Secret scanners herkennen het kenmerk abk_, dus een sleutel die per ongeluk in een repository belandt, is snel gevonden.
Alleen HTTPS krijgt antwoord. Er zijn geen cookies en geen sessies: elk verzoek staat op zichzelf.
Wat een sleutel bereikt
Een sleutel hoort bij één werkruimte en bereikt niets anders. Een evenement, deelnemer of webhook van een andere werkruimte antwoordt 404, precies alsof hij niet bestaat, dus een sleutel kan nooit te weten komen wat een andere organisator heeft.
De demonstratiewerkruimte heeft geen eigen sleutels. Maak een eigen werkruimte om schrijfacties te proberen; wat je in deze documentatie van Beacon Summit leest, zijn de echte gegevens van de demonstratie.
Scopes
Een scope is een onderdeel plus een toegang: events:read, attendees:write. Geef een sleutel de scopes die zijn software nodig heeft en niets meer, zodat een uitgelekte sleutel ook niet meer prijsgeeft.
- Schrijven omvat lezen binnen hetzelfde onderdeel: een sleutel met
program:writekan ook sessies lezen. people:readis een eigen scope. Zonder die scope zijn mensen id's: een deelnemer heeft een ticket, een status en een incheckmoment, maar geen naam, adres, bedrijf of antwoorden, enpersonalDatazegtwithheld. Tellingen, verkoop en het programma hebben geen persoon nodig.- Een aanroep die een scope nodig heeft die de sleutel mist, antwoordt
403met"code": "missingScope", en"scope"noemt wat er ontbreekt. Scopes kies je bij het maken van een sleutel; wil je andere scopes, maak dan een nieuwe sleutel.
| Scope | Staat toe |
|---|---|
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. |
De werkruimte biedt vier vertrekpunten: Dashboard (evenementen, tickets, bestellingen, check-ins en het programma, alleen lezen), Power Automate of Zapier (wat de connector en de Zapier-app gebruiken), AI-assistent (alles lezen, mensen inbegrepen) en Alles.
Sleutels van vóór oktober 2026
Sleutels van vóór de scopes per onderdeel hadden read en write. Die zijn omgezet naar wat ze betekenden en blijven precies zo werken als eerst: read werd elke leesscope die er was (mensen inbegrepen), write werd attendees:write en checkins:write. Geen enkele sleutel kreeg er een nieuwe bevoegdheid bij.
Verlopen en intrekken
Een sleutel kan na 30, 90, 180 of 365 dagen verlopen, of nooit. Een verlopen sleutel antwoordt 401 met "code": "keyExpired"; maak de nieuwe sleutel voor de vervaldag van de oude en wissel hem om, dan stopt er niets.
Een sleutel intrekken in de werkruimte stopt hem meteen (keyRevoked). De Power Automate-flows en Zaps die hij heeft geabonneerd, worden met hem afgemeld, omdat ze zich zelf niet meer kunnen afmelden.
De activiteit van sleutels
Integraties › API & MCP › Activiteit van sleutels toont elke aanroep die een sleutel de afgelopen 90 dagen via de API of de MCP-server deed: wanneer, welke bewerking (de route, zoals GET /events/{eventId}/attendees, of de MCP-tool), welk antwoord er kwam, hoe lang het duurde en vanaf welk adres. Nooit een querystring, een body of een antwoord: het adres van een deelnemer in een zoekopdracht hoort niet in een logboek. Geweigerde aanroepen staan er ook, met hun code, dus als een flow stopt, kijk je hier eerst naar missingScope of rateLimited.
Wijzigingen met een sleutel staan ook in het activiteitenoverzicht van de werkruimte, met de naam van de sleutel: "API key abk_k7m2qx9vtw4p (Attendee sync for the CRM)".
Sleutels veilig houden
- Eén sleutel per stuk software, met de naam ervan, zodat je er één intrekt zonder de andere te stoppen.
- Bewaar sleutels in een geheimenkluis (Key Vault, de secrets van je CI, een wachtwoordmanager), nooit in code of een repository.
- Stuur een sleutel nooit naar een browser. De knop Probeer het in deze documentatie is de uitzondering die je zelf maakt: de sleutel blijft in het geheugen van die pagina en gaat alleen naar attendbeacon.com.
- Geef sleutels een vervaldatum, en trek de sleutels in die volgens de activiteitenlijst door niemand worden gebruikt.