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 and Factory administrator users in Evocon.
To generate a new API key, follow these steps:
Go to Settings and click on the “API keys” card:
Click on the “+ API KEY” button in the top right corner.
Add a name for this key that describes where it’s used and choose the key rights.
Custom reports
This option restricts access to the api.evocon.com/api/reports/… URL and is used for connecting Evocon reporting data to an external reporting tool like Excel or Power Bi with read-only rights. This option gives access to all stations’ data. Filters can be applied on the report level.
User rights
This option copies the access rights of an existing user. For example, if a user has read-only access to “Station 1” and read-write access to “Station 2” then with this key, the external system can read information about “Station 1” and “Station 2”, but only write information (insert stops, changeovers etc) for “Station 2”. This integration can be used for sending production orders to Evocon or building API-based automations.
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 credentials must be created by connecting the API key and Secret key by colon : and base64 encoding the result. For example: EVO123456789**:**SeCrEtKeY123 would become RVZPMTIzNDU2Nzg5OlNlQ3JFdEtlWTEyMw==
This would be used in request headers as ’Authorization: Basic RVZPMTIzNDU2Nzg5OlNlQ3JFdEtlWTEyMw==’
When using the built-in Basic Authentication fields in an application like Excel then Username is API key and password is Secret key.
</aside>
Save the values securely, tick the box and click “Done” to confirm.
Below are a few examples how the key can be used when interfacing with Evocon.
Evocon API - Connecting OEE and Losses production data to Excel
Evocon API - Connecting Client Metrics data to Excel
Evocon API - Connecting Checklists data to Excel