External API
Edition: SaaS Enterprise
Agile Data Engine External API provides an interface for connecting external services with ADE processes. External API is exclusive for the SaaS Enterprise edition. A Swagger UI is provided which serves as a detailed documentation and enables manual API calls from a user interface mainly for development and testing purposes.
See also:
Usage
API URLs are in the following format:
https://external.services.saas.agiledataengine.com/external-api/api/{tenant}/{installation}/{environment}/...
Where:
{tenant} is the SaaS tenant, e.g. s1234567.
{installation} = datahub
{environment} is the environment name, e.g. design, dev, test or prod.
Tenant name is part of the URL of your Agile Data Engine account. Environment names are listed in the Designer front page under Environments.
Access the Swagger UI here. Select the interface with Select a definition.
CLI tool
A command line interface (CLI) tool for using External API is available in Github.
Authentication
All requests have to be authenticated. When calling the APIs from an external service, authentication is done with an API key and secret which are provided by the Agile Data Engine support team. Also, the public IP address of the service executing the requests has to be allowed by the support team. Allowed IP addresses are configured per API key.
Authentication in the user interface:
Navigate to the Swagger UI.
Select the interface from the top with Select a definition.
Input Tenant, Installation and Environment.
Authorize the requests by pressing Authorize, input your API key and key secret.
Interfaces
Currently External API supports the following features:
Interface | Environment Type | Description |
|---|---|---|
Dagger | RUNTIME | Trigger workflows (DAGs) and query workflow run status. |
Deployment | DESIGN | Query the commits, promotion and deployment statuses of package versions per environment. Export package JSON of a certain commit. Control promotions, demotions and deploys. |
Run ID | RUNTIME | Query, Add, Remove Run IDs per environment and entity. |
Code | RUNTIME | Get generated runtime load steps of a certain package / a certain entity. |
Metadata | DESIGN, RUNTIME | Query ADE metadata using GraphQL. |
Please refer to the Swagger UI for detailed instructions.