API Keys
Ours is an authorization-based model, requiring an authorization key for access to our APIs (modules). Here's where you generate this key. API keys provide a seamless way for programmatic access to our APIs. To generate API keys, navigate to Settings > General > API Keys.
Generating API Keys
There are three types of APIs that you can access. When generating a key for calling the APIs, you have the flexibility to grant access to individual APIs or any combination thereof:
- Deployment API: Used for deploying applications from A8Studio.
- Export Application API: Used to export the application's data history (data dump).
- Start New Process API: To start a new Assisted flow remotely.
To generate a key, select the checkbox next to the relevant API(s) and click the Generate
button.
- After generating the key, simply copy the key by clicking on the 'Copy' icon.
Available API Scopes
Deployment API
With the Deployment API you can deploy your A8Studio applications directly into the A8Flow runtime environment. This streamlines the deployment process, making it efficient and hassle-free for the users.
Checkout: How to add the Deployment API key to A8Studio.
Export Application API
The Export Application API provides a comprehensive record of changes made in the application within a specified time frame, facilitating a seamless transfer of application modifications between environments.
URL: /flow/v2/exports/applications
Method: GET
Make a GET request to the above URL with your authentication key in the request headers. The result will be returned in JSON format and will include all instances/changes made in the application during the specified period.
For Query Parameters click here.
Start New Process API
The Start New Process API automates the initiation of new process instances, enhancing overall workflow efficiency. It allows for triggering an instance within a specific environment from a different one; a good example would be working seamlessly between the Solo and Assisted environments.