Skip to content
English
Log to my account
  • There are no suggestions because the search field is empty.

API Keys for Master Licenses and Domains

API keys are critical for accessing client domains and associated applications. This guide explains how API keys work and how they are tied to Master Licenses and Domains. It will help clients understand the process of requesting and using API keys across different applications.

1. Master Licenses Overview

Each client is assigned Master Licenses based on their client level:

  • Blue Clients: 1 Master License
  • Gold Clients: 2 Master Licenses
  • Platinum Clients: 3 Master Licenses

A Master License is tied to a Domain, which refers to a specific database.

2. Domains and Application Access

Clients have access to their domain(s) through various applications, such as:

  • Workflow Application
  • Mobile App
  • ERP systems (e.g., XSS, with whom we have partnerships)

To access a domain through these applications, a unique key is required—this is the API key.

3. What Is an API Key?

An API key allows a client to access their data within a Domain via an application. Each application that the client wants to use needs its own unique API key to access the Domain. These keys ensure that only authorized applications and users have access to the domain's data.

4. API Keys for Applications

  • One API key per application: Each application (e.g., Workflow, Mobile App) requires a separate API key to access a Domain.
  • Linked to a single Master License: API keys are tied to a specific Master License, meaning they provide access to one Domain only.
  • Multiple applications: A client may request multiple API keys if they use different applications to access the same Domain.


5. How to Request API Keys

If a client needs an API key for a new application (or additional API keys for multiple apps), they should contact support or their account manager to receive the keys required for the new integration.

API keys play an essential role in securing and controlling access to a client's domain via various applications. Each Master License corresponds to a Domain, and an API key is required for each application that accesses the Domain. Clients can request additional API keys as needed for their setup.