Aloitus
Tunnistautuminen ja käyttöoikeudet
Jokaisessa kutsussa on API-avain. Avain ulottuu yhteen työtilaan, tekee sen, mitä sen käyttöoikeudet sallivat, ja voi vanhentua.
Avaimen lähettäminen
Lähetä avain Bearer-tunnuksena. Työkalut, jotka osaavat täyttää vain nimetyn otsakkeen, voivat käyttää sen sijaan X-Api-Key-otsaketta; kummassakin on sama avain.
GET /api/v1/events HTTP/1.1
Host: attendbeacon.com
Authorization: Bearer abk_k7m2qx9vtw4p_...Avain näyttää tältä: abk_, kaksitoista merkkiä, alaviiva ja 43 merkin salaisuus. Kaksitoista merkkiä ovat sen etuliite: työtila näyttää ne, jotta erotat avaimet toisistaan, ja avainten käyttöloki nimeää avaimet niiden mukaan. Salaisuuksien skannerit tunnistavat abk_-merkinnän, joten vahingossa repositorioon päätynyt avain on helppo löytää.
Vain HTTPS-pyyntöihin vastataan. Evästeitä tai istuntoja ei ole: jokainen pyyntö on itsenäinen.
Mihin avain ulottuu
Avain kuuluu yhteen työtilaan eikä ulotu mihinkään muuhun. Toisen työtilan tapahtuma, osallistuja tai webhook vastaa 404, täsmälleen kuin sitä ei olisi olemassa, joten avain ei voi koskaan saada selville, mitä toisella järjestäjällä on.
Esittelytyötilassa ei ole omia avaimia. Luo oma työtila kokeillaksesi kirjoittamista; näiden ohjeiden Beacon Summit -lukuesimerkit ovat esittelyn todellisia tietoja.
Käyttöoikeudet
Käyttöoikeus on alue ja pääsytaso: events:read, attendees:write. Anna avaimelle vain ne käyttöoikeudet, joita sen ohjelmisto tarvitsee, niin vuotanut avain ei paljasta sen enempää.
- Kirjoitusoikeus sisältää lukuoikeuden samalla alueella: avain, jolla on
program:write, voi myös lukea ohjelmaosuuksia. people:readon oma käyttöoikeutensa. Ilman sitä ihmiset ovat tunnisteita: osallistujalla on lippu, tila ja saapumisaika, mutta ei nimeä, osoitetta, yritystä tai vastauksia, japersonalDataonwithheld. Määrät, myynti ja ohjelma eivät tarvitse henkilötietoja.- Kutsu, joka tarvitsee avaimelta puuttuvan käyttöoikeuden, vastaa
403,"code": "missingScope"ja"scope", joka nimeää puuttuvan oikeuden. Käyttöoikeudet valitaan avainta luotaessa; jos tarvitset eri oikeudet, luo uusi avain.
| Käyttöoikeus | Sallii |
|---|---|
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. |
Työtila tarjoaa neljä pohjaa: Koontinäyttö (tapahtumat, liput, tilaukset, saapumiskirjaukset ja ohjelma, vain luku), Power Automate tai Zapier (mitä liitin ja Zapier-sovellus käyttävät), Tekoälyavustaja (kaikki luettavissa, henkilötiedot mukaan lukien) ja Kaikki.
Ennen lokakuuta 2026 luodut avaimet
Ennen aluekohtaisia käyttöoikeuksia avaimilla oli read ja write. Ne kirjoitettiin uudelleen vastaamaan sitä, mitä ne tarkoittivat, ja ne toimivat täsmälleen kuten ennenkin: read muuttui kaikiksi silloin olemassa olleiksi lukuoikeuksiksi (henkilötiedot mukaan lukien), write muuttui oikeuksiksi attendees:write ja checkins:write. Mikään ei saanut uusia valtuuksia.
Vanheneminen ja peruuttaminen
Avain voi vanhentua 30, 90, 180 tai 365 päivän kuluttua tai ei koskaan. Vanhentunut avain vastaa 401 ja "code": "keyExpired"; luo uusi avain ennen vanhan viimeistä päivää ja vaihda se tilalle, niin mikään ei pysähdy.
Avaimen peruuttaminen työtilassa pysäyttää sen heti (keyRevoked). Sen kautta tehdyt Power Automate -työnkulkujen ja Zapien tilaukset perutaan samalla, koska ne eivät enää pystyisi perumaan tilaustaan itse.
Avainten käyttöloki
Integraatiot › API & MCP › Avainten käyttöloki luettelee jokaisen kutsun, jonka avain on tehnyt rajapinnan tai MCP-palvelimen kautta viimeisten 90 päivän aikana: milloin, mikä toiminto (reitti, kuten GET /events/{eventId}/attendees, tai MCP-työkalu), miten siihen vastattiin, kauanko se kesti ja mistä osoitteesta. Ei koskaan kyselymerkkijonoa, runkoa tai vastausta: haussa käytetty osallistujan osoite ei saa jäädä lokiin. Myös hylätyt kutsut näkyvät koodeineen, joten missingScope tai rateLimited on ensimmäinen paikka katsoa, kun työnkulku pysähtyy.
Avaimella tehdyt muutokset näkyvät myös työtilan toimintalokissa avaimen nimellä: "API key abk_k7m2qx9vtw4p (Attendee sync for the CRM)".
Avainten turvallinen säilytys
- Yksi avain ohjelmistoa kohden, nimettynä sen mukaan, niin voit peruuttaa yhden pysäyttämättä muita.
- Säilytä avaimet salaisuuksien säilössä (Key Vault, CI-järjestelmäsi salaisuudet, salasanojen hallinta), ei koskaan koodissa tai repositoriossa.
- Älä koskaan lähetä avainta selaimeen. Näiden ohjeiden Kokeile-painike on poikkeus, jonka teet itse: avain pysyy sivun muistissa ja menee vain osoitteeseen attendbeacon.com.
- Anna avaimille voimassaoloaika ja peruuta ne, joita käyttölokin mukaan kukaan ei käytä.