🔑API Overview

Our open API lets you create seamless integrations with the illu platform

The illu API enable your team to , minimizing data loss, mistakes, and time to make manual data transfers. With the API you can, for example:

• Trigger illu jobs when an alert is triggered

• Create and update sites on illu when a new project is greenlit

• Trigger invites to new users to join your organization

• Update job status in illu when work is approved

If you need help implementing the APIs, please reach out to the illu support team at [e-mail].

API Key and Authentication

The illu API uses API keys to authenticate requests. Only admin users can generate and view an API key and only on the web application. To view your API key

1. Open the Admin Console. To access the Admin Console, click your Account Icon in the top right corner of the screen to open a drop down menu. Click the to open it.
2. Navigate to the API Key tab

3. Press Show Key and enter your password to reveal the key
4. You can regenerate an API key by pressing the refresh icon

Whenever your password is changed or API key is regenerated, any integrations using the previous API key will be invalidated.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Use your API key in your request header in the format below.

Authorization: Bearer {{your_api_key}}

API Specifications

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Please see the API documentation of the latest version below:

FastAPI - ReDoc

Use Case Examples

⚠️pageTrigger New Job on Alert

📍pageCreate New Site on Project Start

✅pageUpdate Job Status on Approval