Skip to main content
Close announcements banner
SaaS API overview

ON THIS PAGE

SaaS API overview

The Qlik Application Automation for OEM SaaS API can be used by SaaS partners of Qlik Application Automation for OEM to manage their customer accounts, integration templates and active integrations (automations) inside customer accounts.

SaaS partners can also manage their customer accounts, integration templates and active customer integrations manually (non-programmatically) through the SaaS Admin backend.

Qlik Application Automation for OEM supports various embedding scenario's to embed integrations in your own SaaS UI. The usage of the SaaS API is optional and typically used in combination with a deep embedding scenario.

Base URL

https://api.blendr.io/v1

Authentication

Use the app id and API key from your SaaS Admin account, and add them as headers:

X-App-Id: 12345
X-Api-Key: xxxxx

Paging

Paging can be done by using the links in the response, or by adding a page parameter in the querystring. The first page is 1.

Example response with links and meta:

{
    "data": [
       
    ],
    "links": {
        "first": "https://api.blendr.io/v1/accounts?page=1",
        "last": "https://api.blendr.io/v1/accounts?page=10",
        "prev": "https://api.blendr.io/v1/accounts?page=1",
        "next": "https://api.blendr.io/v1/accounts?page=3"
    },
    "meta": {
        "current_page": 2,
        "from": 101,
        "last_page": 10,
        "path": "https://api.blendr.io/v1/accounts?page=2",
        "per_page": 100,
        "to": 200,
        "total": 1050
    }
}

Rate limits

The total amount of API calls to the Qlik Application Automation for OEM API's is limited to maximum 300 calls per minute per account. This includes API's to the Qlik Application Automation for OEM SaaS API, executing Triggered automations via their API URL etc.

Qlik Application Automation for OEM allows the creation of a maximum of 200 queued jobs (automation executions), regardless of how they were created, e.g. via a Triggered automation URL or via the Qlik Application Automation for OEM SaaS API.

If the rate limit is exceeded, you will receive a 429 response code (Too many requests). The response headers will include:

  • x-ratelimit-limit: total allowed number of API calls (per minute)
  • x-ratelimit-remaining: number of API calls remaining before rate limit is hit