View Source

Integrate in 15 Minutes

Autheona provides a robust platform and API designed for seamless integration. Our architecture allows you to integrate once and manage rules or behavior directly from the platform without needing to modify your codebase further.

The following steps outline the setup process to get your project running:

  1. Sign up for an Autheona account.
  2. Create a new project.
  3. Generate an access token.
  4. Configure your policy.
  5. Integrate the API into your application.

1. Sign Up

Creating an account is a straightforward process:

  1. Navigate to the Sign Up page.
  2. Enter your email address and continue.
  3. Check your inbox for a verification email and click the provided link.
  4. On the registration page, enter your name and password, then confirm the password.
  5. Upon continuing, your account will be created automatically, and you will be directed to the onboarding flow.

2. Create a New Project

Once your account is active, you must create a project to use the API.

  • Production: Intended for live, real-world use cases.
  • Sandbox: Intended for testing and development.

Note

If you are a new user, we recommend starting with a Sandbox project.

To create a project:

  1. Click the Plus (+) button located in the top navigation bar, or click here.
  2. Enter your Project Name.
  3. Enter a Project Unique Name; this acts as the identifier for your project across the platform.

3. Create an Access Token

Access tokens are required to authenticate your API requests.

  1. Open the Access Token page via the side navigation bar.
  2. Click the Create Access Token button.
  3. In the modal that appears, set an expiration date and a meaningful description for the token.
  4. Click the creation button to generate the token.

Important

The access token is only displayed once during the generation process. Please copy it immediately and store it in a secure location. Tokens cannot be edited once created.

4. Upgrade Policy

Policies define the core configuration and conditions for your API. Because policies are comprehensive, we recommend utilizing our pre-built templates to get started.

  1. Access the Policy Editor from the side navigation bar.
  2. Select and copy a Policy Template.
  3. Paste the template into the Policy Editor and customize as needed.

5. Integrate API

Before full integration, you may test the API using the following cURL command. Replace <access-token> with your actual token and provide an email address that matches your project policy.

curl -X POST "https://api.autheona.com/v1/intelligence" \
  -H "Content-Type: application/json" \
  -H "x-api-key: <access-token>" \
  -d '{
    "email_address": "<email-address>"
  }'

Once you have verified the results, you may proceed with the integration. Copy the relevant code block for your environment and integrate it into your application's email registration flow.