API Keys

API keys are implemented in order to track and control the use of the API. Create the keys and assign permissions for the performance of specific actions. They are essential when you integrate Synerise with other systems that you use in your daily work.

Permissions

Permissions allow you to define what kind of API methods are allowed in terms of one API key (the API methods are available at the link here). This allows users to create customized API keys for the needs of a particular integration. Such structure ensures the users with safety when a key is stolen. As an additional form of protection, there is a possibility of defining IP addresses where the given API key can be used.

Tip: We highly recommend changing API keys every 3-6 months for improved security.
Image presents a fragment of the permission list
A fragment of the permission list

Requirements


  • Plan the API key permission structure.
  • Your account's permissions must allow access to the API keys section.

Procedure


Image presents list of API keys
List of API keys
  1. Go to Settings > API keys.

  2. Define the audience of the key by choosing one of the options above the list of API keys:

    • Client - Keys in this section are used mostly in mobile applications when the Synerise RaaS (Registration-as-a-Service) is used. They allow to register, log in, update some profile data and more.
    • Business Profile - Keys in this section are used for operations which can’t be bound to any client or user. Usually these operations are related to profile administration or batch processing.
  3. Optionally, you can add a group to which you can add your API keys. Click the Add group button.

    Tip: Groups are meant to help you with organizing API keys.
  4. To add a new API key, click the Add API key button.

    Tip: There are more Add API key buttons: one general in the upper right corner and one button in every group of API keys. When you create an API key by clicking the general button, you can assign it to a particular API key group. When you create an API key within a specific group, it is automatically assigned to this group.
  5. On the pop-up, enter the name of the API key.

  6. To add the key to a group, select a group from the Group dropdown list.

  7. Optionally, to let other users know about the purpose of the key, write a short description.

  8. To define the IP addresses from which the API key can be used, click the Advanced options buttons.

  9. Tick the IP policy option.

  10. In the IP address enter the address. If you want to add more addresses, click the Add parameter button.

  11. To complete the process, click the Save button.
    Result: The API key is added to the list.

  12. To define the scope of permissions for the API key, locate the key on the list and click the Permissions button. From the list, select the methods by ticking the checkboxes.

    Tip: You can define permissions for the methods available at the link.
  13. Confirm your choice by clicking Apply settings.

  14. To view the API key, click the Three-dot icon icon. At the bottom of the dropdown, you can copy the code by clicking the section with the code.

Image presents the example of key
An example of an API key
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.