API keys are used to connect other applications or services (ERP, Excel, Power BI, custom programs) to Evocon and move data between Evocon and these services. Once created, API keys can no longer be edited - they can only be disabled, enabled or deleted.

API keys are available only to Company administrator users in Evocon.

How to generate an API key?

To generate a new API key, follow these steps:

  1. Go to Settings and click on the “API keys” card:

    Untitled

  2. Click on the “+ API KEY” button in the top right corner.

  3. Add a name for this key that describes where it’s used and choose the key rights.

    Untitled

  4. Click “Create” to generate the new key. The key is active and can be used as soon as it’s generated.

    <aside> ❗ You can see the key password only once, make sure to save it in a secure location and don’t share it via unsecure channels.

    </aside>

    <aside> ❗ When making API requests using Authorization header, the token must be created by connecting the API key and Secret key by : and base64 encoding the result. For example: EVO123456789:SeCrEtKeY123 would become RVZPMTIzNDU2Nzg5OlNlQ3JFdEtlWTEyMw==

    When using the built-in Basic Authentication fields then Username is API key and password is Secret key in the picture below.

    </aside>

    Untitled

  5. Save the values securely, tick the box and click “Done” to confirm.

How to use the key?

Below are a few examples how the key can be used when interfacing with Evocon.

Exporting data from Evocon

Evocon API - Connecting Evocon production data to Excel

Evocon API - Connecting Client Metrics data to Excel

Evocon API - Connecting Checklists data to Excel

Importing data to Evocon