Quickstart

Create an API key

In EMS, go to Settings › API keys and choose Create API key. Name it after what it’s for (for example “Website sync”), tick Read events, and pick when it expires.You get two values:

a public key like ems_pk_live_…
a secret key like ems_sk_live_…

The secret key is shown once. Copy it into your server’s secret store straight away. If you lose it, revoke the key and create a new one.

Only your organisation’s owners and admins can create keys.

Check the key

Call whoami with HTTP Basic auth: the public key is the username and the secret key is the password.

curl -u "$EMS_PUBLIC_KEY:$EMS_SECRET_KEY" \
  https://ems-api.aventia.africa/api/public/v1/whoami

const auth = Buffer.from(`${process.env.EMS_PUBLIC_KEY}:${process.env.EMS_SECRET_KEY}`).toString('base64')
const res = await fetch('https://ems-api.aventia.africa/api/public/v1/whoami', {
  headers: { Authorization: `Basic ${auth}` },
})
console.log(await res.json())

import os, requests

res = requests.get(
    "https://ems-api.aventia.africa/api/public/v1/whoami",
    auth=(os.environ["EMS_PUBLIC_KEY"], os.environ["EMS_SECRET_KEY"]),
    timeout=30,
)
print(res.json())

You should see your organisation and the key’s scopes:

{
  "organisation": { "id": "019a…", "name": "Acme Events" },
  "key": { "name": "Website sync", "public_key": "ems_pk_live_…", "scopes": ["events:read"] }
}

List your events

curl -u "$EMS_PUBLIC_KEY:$EMS_SECRET_KEY" \
  "https://ems-api.aventia.africa/api/public/v1/events?limit=25"

Events come back earliest first. If there are more, the response has a next_cursor: see Pagination.

Get started

Using the API

Guides

More