API-viiteopas

Workspace

The key and the workspace it reaches.

Check a key

GET/me

Returns the key's workspace, its scopes, when it expires and its rate limit. Any working key may call it: it is how a connector checks a key.

Käyttöoikeudet: Mikä tahansa toimiva avain

Vastaukset

200 The key works. Me
Kentät
- workspaceIdstring (uuid)
  The workspace's id.
- workspaceNamestring
  The workspace's name.
- keyNamestring
  The name the key was given.
- scopesstring[]
  What the key may do: events:read, people:read and the others.
- keyPrefixstring
  The key's prefix, as lists show it: abk_ and twelve characters.
- expiresUtcstring (date-time) tai null
  When the key stops working, in UTC; null when it does not expire.
- rateLimitRateLimitInfo
  The key's limit.
  Näytä kentät
  - perMinuteinteger (int32)
    Calls a minute, the REST API and the MCP server together.
  - windowSecondsinteger (int32)
    The window the limit counts in, in seconds.
401 invalidKey, keyExpired, keyRevoked.
429 rateLimited.

Hylkäykset

invalidKey keyExpired keyRevoked rateLimited

Pyyntö

curl "https://attendbeacon.com/api/v1/me" \
  -H "Authorization: Bearer $ATTENDBEACON_KEY"

const response = await fetch("https://attendbeacon.com/api/v1/me", {
  headers: {
    Authorization: `Bearer ${process.env.ATTENDBEACON_KEY}`
  }
});
if (!response.ok) throw new Error((await response.json()).detail);
const data = await response.json();

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("ATTENDBEACON_KEY"));

using var request = new HttpRequestMessage(HttpMethod.Get, "https://attendbeacon.com/api/v1/me");

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

import os
import requests

response = requests.get(
    "https://attendbeacon.com/api/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['ATTENDBEACON_KEY']}"
    }
)
response.raise_for_status()
data = response.json()

$headers = @{
    Authorization = "Bearer $env:ATTENDBEACON_KEY"
}

$data = Invoke-RestMethod -Method Get -Uri "https://attendbeacon.com/api/v1/me" -Headers $headers

200 Esimerkkivastaus

JSON

{
  "workspaceId": "3d9a5c1e-7b2f-4e8a-a6d4-0c1b9e7f5a23",
  "workspaceName": "Beacon Events",
  "keyName": "Sales dashboard",
  "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 invalidKey, keyExpired, keyRevoked.

JSON

{
  "type": "https://attendbeacon.com/developers/errors#invalidKey",
  "title": "No working API key",
  "status": 401,
  "detail": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key.",
  "instance": "/api/v1/me",
  "code": "invalidKey",
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "error": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key."
}

Get the workspace

GET/workspace

Returns the workspace the key reaches, how many events it has, the key itself and where the MCP server and the docs are.

Käyttöoikeudet: Mikä tahansa toimiva avain

Vastaukset

200 The workspace. Workspace
Kentät
- workspaceIdstring (uuid)
  The workspace's id.
- namestring
  Its name.
- demonstrationboolean
  Whether it is the demonstration workspace, which the API reads and never changes.
- eventsinteger (int32)
  How many events it has.
- publishedEventsinteger (int32)
  Of which published.
- keyobject
  The key this call was made with.
  Näytä kentät
  - apiKeyIdstring (uuid)
    The key's id.
  - namestring
    What the key is for.
  - prefixstring
    Its prefix: abk_ and twelve characters.
  - scopesstring[]
    What it may do.
  - createdUtcstring (date-time)
    When it was made, in UTC.
  - expiresUtcstring (date-time) tai null
    When it stops working, in UTC; null for never.
- rateLimitRateLimitInfo
  The key's limit.
  Näytä kentät
  - perMinuteinteger (int32)
    Calls a minute, the REST API and the MCP server together.
  - windowSecondsinteger (int32)
    The window the limit counts in, in seconds.
- mcpstring (uri)
  The MCP server's address.
- docsstring (uri)
  The developer docs.
401 invalidKey, keyExpired, keyRevoked.
429 rateLimited.

Hylkäykset

invalidKey keyExpired keyRevoked rateLimited

Pyyntö

curl "https://attendbeacon.com/api/v1/workspace" \
  -H "Authorization: Bearer $ATTENDBEACON_KEY"

const response = await fetch("https://attendbeacon.com/api/v1/workspace", {
  headers: {
    Authorization: `Bearer ${process.env.ATTENDBEACON_KEY}`
  }
});
if (!response.ok) throw new Error((await response.json()).detail);
const data = await response.json();

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("ATTENDBEACON_KEY"));

using var request = new HttpRequestMessage(HttpMethod.Get, "https://attendbeacon.com/api/v1/workspace");

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

import os
import requests

response = requests.get(
    "https://attendbeacon.com/api/v1/workspace",
    headers={
        "Authorization": f"Bearer {os.environ['ATTENDBEACON_KEY']}"
    }
)
response.raise_for_status()
data = response.json()

$headers = @{
    Authorization = "Bearer $env:ATTENDBEACON_KEY"
}

$data = Invoke-RestMethod -Method Get -Uri "https://attendbeacon.com/api/v1/workspace" -Headers $headers

200 Esimerkkivastaus

JSON

{
  "workspaceId": "3d9a5c1e-7b2f-4e8a-a6d4-0c1b9e7f5a23",
  "name": "Beacon Events",
  "demonstration": false,
  "events": 12,
  "publishedEvents": 6,
  "key": {
    "apiKeyId": "5f0c2a6e-8d1b-4c3a-9e7f-2b6d4a1c8e90",
    "name": "Sales dashboard",
    "prefix": "abk_k7m2qx9vtw4p",
    "scopes": [
      "events:read",
      "tickets:read",
      "orders:read",
      "attendees:read",
      "checkins:read",
      "program:read",
      "people:read"
    ],
    "createdUtc": "2026-10-14T21:42:42.243Z",
    "expiresUtc": "2027-01-12T09:00:00.000Z"
  },
  "rateLimit": {
    "perMinute": 120,
    "windowSeconds": 60
  },
  "mcp": "https://attendbeacon.com/mcp",
  "docs": "https://attendbeacon.com/developers/"
}

401 invalidKey, keyExpired, keyRevoked.

JSON

{
  "type": "https://attendbeacon.com/developers/errors#invalidKey",
  "title": "No working API key",
  "status": 401,
  "detail": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key.",
  "instance": "/api/v1/workspace",
  "code": "invalidKey",
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "error": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key."
}

Oppaat ja tämä sivusto ovat omalla kielelläsi. API-viiteoppaan omat kuvaukset ovat englanniksi, kuten itse rajapintakin.

#Check a key

Vastaukset

Hylkäykset

#Get the workspace

Vastaukset

Hylkäykset

Check a key

Get the workspace