Integration Guide

The Athena API is a RESTful web service that allows you to interact with Athena programmatically. You can use the API to automate tasks, integrate Athena with other systems, and build custom applications that leverage Athena's features.

An important concept is that Athena is a multi-tenanted system. This means that a single instance of Athena can serve multiple organizations, each with its own data and configuration. When you interact with the API, you will need to specify the tenant you are working with.

Getting Started

To get started with the Athena API, you will need to first identify the tenant you are working with. The tenant will be attached to requests using the X-tenant-Id header. For example the following Typescript request asks for a single course of id 1 from the Athena API:

import axios from 'axios';

const tenantId = 'your-tenant-id';
const courseId = 1;

const response = await axios.get(`https://api-server-prod.aceware.com/course/${courseId}`, {
  headers: {
    'X-tenant-Id': tenantId
  }
});

console.log(response.data);

A full list of available endpoints can be found in the API Reference.