Skip to main content

API management

Generate and manage API keys to sync data between Apsis One and other systems

API management

The API management tab in Account settings is where Admin Users generate API keys. These keys allow other applications — your CRM, e-commerce platform, custom integrations, or BI tools — to read from and write to your Apsis One data through the API. Also visit our Developer Hub here.

💡 What's an API key for?

An API key is a credential that lets external software identify itself to Apsis One. It's like a username and password for your integrations: each key has a Client ID (identifier) and a Secret (password). These together authorise the connecting system to perform actions in your Apsis One account.

In this article

When to use API keys

🔄 Sync profile data from your CRM

Push customer records from your other sources into Apsis One so they're available for segmentation and email sending.

🛒 Track e-commerce events

Create custom events from any external source to enrich your profiles with behavioural triggers to use in Marketing Automation, personalisation, increased relevance or segmentation.

📊 Export data to BI tools

Pull email engagement, segment membership, or profile data export into your BI stack (Power BI, Tableau, Looker) for cross-channel reporting.

🔌 Custom integrations

Build your own integration for a system Apsis One doesn't natively support — for example, syncing event registrations from a homegrown event platform.

Before you start

  • You need Admin User rights to access the API Management tab. If the tab isn't visible, contact your Account Owner (or an Admin).
    ​

  • Decide which Sections the integration should access — keys can be scoped to one Section or several.
    ​

  • Decide which Keyspace permissions the integration needs (e.g. read-only vs. full read/write).
    ​

  • Have a safe place ready to store the Client ID and Secret — once created, the Secret is shown only once.

Treat API keys like passwords - An API key with write permissions can update profiles, send emails, and modify your account data. Anyone who has the key can do anything the key is authorised to do — so store keys securely (password manager or encrypted secrets store) and never commit them to a public repository or share them in chat.

How to add an API key

  1. Click your Profile Icon in the top right corner and go to Account settings.

  2. Click the API Management tab in the left menu.
    ​

  3. Click Add API Key in the top right corner.

  4. Give the API key a name.

  5. If you have transactional email sendings activated on your account you also have the option to check the box for allowing to send transactional emails.
    ​

  6. Click Create.

✅ Naming tip - Use a name that tells you what the key is for and where it's used — for example "CRM Integration - production" or "Integration X webhook - staging". Generic names like "API key 1" become a problem the moment you have more than one to manage.

Click Copy Client ID to copy the Client ID.

Click Copy Secret to copy the Secret.

Save the Client ID and Secret key in a safe place immediately.

The Secret is shown only once - After you close the creation dialog, the full Secret cannot be retrieved again. If you lose it, the only fix is to delete the key and create a new one (and update wherever the old key was being used). Copy and store it before you click away.

It is possible to rename and delete an API Key, but not deactivate or restore.
​
​

Security best practices

  • Store keys securely. Use a password manager, secrets vault, or your platform's environment variable system. Never commit keys to source control, and never paste them into Slack, email, or screenshots.
    ​

  • One key per integration. Don't reuse the same key across different systems — if one is compromised or needs rotating, you don't want to break everything else.
    ​

  • Delete unused keys. If an integration is decommissioned, delete its key from the API Management tab. A key sitting unused is just an unnecessary risk.
    ​

Troubleshooting

Issue

Likely cause

Fix

API Management tab is missing

Your user role doesn't have Admin rights.

Ask your Account Owner to grant you Admin rights, or have them generate the key on your behalf.

Lost the Secret after creation

The Secret is shown only once and isn't retrievable.

Delete the key and create a new one. Update wherever the old key was being used.

Integration returns "401 Unauthorized" or "403 Forbidden"

Wrong Client ID/Secret?

Verify the credentials match exactly (no extra spaces).

Integration suddenly stops working

Key was deleted?

Confirm the key still exists in API Management. If rotated, update the integration with the new credentials.

What's next?

  1. Developer Hub — Full API reference, endpoints, request/response formats, and code samples.

  2. About the Apsis One API — Conceptual overview of how the API is structured.

  3. User roles and Permissions — If you can't access API Management, this article explains how to get the right role.

Did this answer your question?