Overview

To integrate Orthogramic with your application, you need an API token to authenticate requests. This guide walks you through generating and managing your API token securely.

Generate a New API Token

1. Click the Add token button.

2. Select the scope of your token:

   1. Organization: All business architecture data for the organization

   2. Document: Only the selected document

3. Select the access of your token:

   • Read-Only: Allows retrieving mindmaps and metadata.

   • Read & Write: Allows creating, updating, and deleting data.

   • Admin: Only Admin users have write access.

4. Click Generate token.

Your new API token will be displayed. Copy and securely store it, as it will only be shown once.

Secure Your API Token

• Do not share your token publicly or expose it in frontend code.

• Store it in environment variables (.env files) or a secrets manager.

• Rotate tokens regularly to maintain security.

• If a token is compromised, revoke and regenerate a new one immediately.

Example environment variable usage:

ORTHOGRAMIC_API_TOKEN=your-secure-token

Using Your API Token

Include the token in the Authorization header of your API requests:

curl -X GET "https://api.orthogramic.com/mindmap/12345" \
     -H "Authorization: Bearer YOUR_API_TOKEN"

Example using JavaScript (fetch API):

fetch("https://api.orthogramic.com/mindmap/12345", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.ORTHOGRAMIC_API_TOKEN}`
  }
})
.then(response => response.json())
.then(data => console.log(data));

Managing API Tokens

• View Active Tokens: See a list of currently active tokens.

• Revoke a Token: Click the Revoke button next to a token to disable it.

• Generate a New Token: Follow the steps above to create a replacement token.

Need Help?

If you experience issues generating or using your API token, please contact support@orthogramic.com.