Get Started

Usage

Learn how to use the AeonPass API to create and manage techaeons.

Prerequisites

Ensure the following are in place before making API calls:

An AeonPass account with Organization setup with API KEY
A valid API Key from the AeonPass developer portal
Node.js 18+ or any HTTP client (curl, Postman, etc.)

Environment variables

The following environment variables are expected by the examples on this page.

# .env.local
AEONPASS_API_URL=https://apv2-gatewayapp-prod-westus3.azurewebsites.net/api
AEONPASS_API_KEY=<your-api-key>

Your first request

Create a techaeon (QR pass) for an organization. Pass your API key in the X-API-KEY header. All body fields are optional.

Request

curl https://apv2-gatewayapp-prod-westus3.azurewebsites.net/api/techaeon/public \
  --request POST \
  --header 'X-API-KEY: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "redirectUrl": null,
  "eventId": null,
  "groupId": null,
  "groupName": null,
  "techaeonHolder": {
    "phone": null,
    "firstName": "",
    "lastName": null,
    "email": null
  }
}'

Field	Type	Description
redirectUrl	string \| null	URL to redirect after check-in
eventId	string \| null	Associate the pass with a specific event
groupId	string \| null	Group to assign the pass to
groupName	string \| null	Display name of the group
techaeonHolder.phone	string \| null	Holder phone number
techaeonHolder.firstName	string	Holder first name
techaeonHolder.lastName	string \| null	Holder last name
techaeonHolder.email	string \| null	Holder email address

Response 201 Created

{
  "id": "string",
  "organizationId": "string",
  "groupId": null,
  "groupName": null,
  "statusId": "string",
  "statusName": "string",
  "statusCode": "string",
  "lastUsedOn": null,
  "techaeonCode": null,
  "techaeonHolder": {
    "id": "string",
    "phone": null,
    "firstName": "string",
    "lastName": null,
    "email": null,
    "userId": null
  }
}

TypeScript / JavaScript

The example below shows how to call the API using the native fetch API. For a fully typed client, generate one from the OpenAPI spec using openapi-typescript or similar tooling.

// lib/aeonpass.ts
const BASE_URL = process.env.AEONPASS_API_URL!

export async function fetchWithAuth(path: string, init?: RequestInit) {
  const token = await getToken() // your token retrieval logic

  return fetch(`${BASE_URL}${path}`, {
    ...init,
    headers: {
      'X-API-KEY': process.env.AEONPASS_API_KEY!,
      'Content-Type': 'application/json',
      ...init?.headers,
    },
  })
}

Introduction Authentication