Why do I need an API key?

API keys are necessary for communication between Synerise and other applications and for using our SDK or plugins. They are also necessary for API authorization. There are two different types of API key - for the workspace and for the Clients, used depending on who you want to authorize as.

How many API keys can I create in my workspace?

You can create as many API keys as you wish. Giving them different access scopes, you can specify access levels for different purposes.

Does my API key have an expiration date?

No, you can use the API key you created as long as you wish.

How do I get an API key?

You can create one in Synerise -> Settings -> API Key, by clicking Add API Key. Remember that to add your API key, you need to specify the name, audience, scope, and roles.

What kind of profile should I choose in API section: workspace or profile?

Keys for workspace login are used for operations which couldn’t be logically bound to any client or user; usually they deal with items such as profile administration or batch processing.

Because of the high access level, we recommend using many keys with different scopes assigned. Using the “one for all” approach may result in problems if the key is stolen by an unauthorized person.