AttendBeacon
Otwórz przestrzeń roboczą

Pierwsze kroki

Szybki start

Utwórz klucz, wykonaj pierwsze wywołanie i pobierz listę uczestników Beacon Summit, wydarzenia demonstracyjnego. Wszystko w pięć minut.

1. Utwórz klucz

W przestrzeni roboczej otwórz Integracje › API & MCP i wybierz Nowy klucz. Nadaj mu nazwę, którą rozpoznasz za pół roku („Synchronizacja uczestników z CRM”), jako punkt wyjścia wybierz Pulpit, zaznacz Uczestnicy: Odczyt oraz Dane osobowe i pozostaw ważność 90 dni.

Klucz jest wyświetlany tylko raz. Skopiuj go od razu: AttendBeacon przechowuje wyłącznie jego skrót, więc zgubionego klucza nie da się odczytać – trzeba go unieważnić i zastąpić nowym. Trzymaj go tam, gdzie twój kod przechowuje sekrety, nigdy w samym kodzie.

export ATTENDBEACON_KEY="abk_k7m2qx9vtw4p_..."

2. Sprawdź klucz

GET /me zwraca przestrzeń roboczą klucza, jego uprawnienia, datę wygaśnięcia i limit. Może je wywołać każdy działający klucz, dlatego to pierwsze pytanie, jakie zadaje łącznik lub skrypt.

curl https://attendbeacon.com/api/v1/me \
  -H "Authorization: Bearer $ATTENDBEACON_KEY"
JSON
{
  "workspaceId": "3d9a5c1e-7b2f-4e8a-a6d4-0c1b9e7f5a23",
  "workspaceName": "Beacon Events",
  "keyName": "Attendee sync for the CRM",
  "keyPrefix": "abk_k7m2qx9vtw4p",
  "scopes": ["events:read", "tickets:read", "orders:read", "attendees:read", "checkins:read", "program:read", "people:read"],
  "expiresUtc": "2027-01-12T09:00:00.000Z",
  "rateLimit": { "perMinute": 120, "windowSeconds": 60 }
}

401 z "code": "invalidKey" oznacza, że klucz nie dotarł albo zawiera literówkę. keyExpired i keyRevoked mówią same za siebie. Wszystkie kody znajdziesz w sekcji Błędy.

3. Znajdź wydarzenie

GET /events zwraca listę wydarzeń przestrzeni roboczej, każde z identyfikatorem. Beacon Summit ma identyfikator b3ac0000-0000-4000-8000-000000000001.

curl "https://attendbeacon.com/api/v1/events?status=published" \
  -H "Authorization: Bearer $ATTENDBEACON_KEY"

4. Pobierz listę uczestników

GET /events/{eventId}/attendees zwraca stronę uczestników, zaczynając od najdawniej zmienionych, oraz nextCursor do pobrania następnej strony. Jeśli klucz ma uprawnienie Dane osobowe, widzisz imiona i nazwiska, adresy i odpowiedzi. Bez niego każdy uczestnik to tylko identyfikator z biletem i statusem.

curl "https://attendbeacon.com/api/v1/events/b3ac0000-0000-4000-8000-000000000001/attendees?limit=2" \
  -H "Authorization: Bearer $ATTENDBEACON_KEY"
JSON
{
  "data": [
    {
      "attendeeId": "b3ac0008-0000-4000-8000-000000000000",
      "orderReference": "DEMOAA",
      "ticketTypeName": "Conference pass",
      "firstName": "Emma",
      "lastName": "Bakker",
      "email": "emma.bakker0@example.com",
      "company": "Contoso",
      "answers": { "dietary": "none", "terms": true, "photos": true },
      "status": "active",
      "orderStatus": "paid",
      "valid": true,
      "checkedInUtc": null,
      "updatedUtc": "2026-10-14T21:40:48.226Z",
      "personalData": "included"
    }
  ],
  "hasMore": true,
  "nextCursor": "YzE6MDYzOTI3NjEwODQ4MjgyMDAwMHxiM2Fj..."
}

Przekazuj nextCursor z powrotem jako cursor, dopóki nie przyjmie wartości null. Wtedy każdego uczestnika odczytasz dokładnie raz. W przewodniku Stronicowanie i synchronizacja znajdziesz gotową pętlę oraz sposób, by pobierać tylko to, co zmieniło się od ostatniego uruchomienia.

Co dalej

Przewodniki i ta witryna są w twoim języku. Opisy w samej dokumentacji API są po angielsku, tak jak mówi samo API.