Authorization

Some API requests require authorization. There are two options to authorize yourself: the session ID and the API key.

Note

If you write your own service, we recommend that you create a specific user for it in the IXM Platform. That means, one specific user per application who has the rights and permissions that you need them to have when using the API.

Session ID

When you're logged into the IXM Platform, you get a session ID. With the API, you can use this session ID to log in as your IXM Platform user.

The session ID is always connected to a user. When you use it, you have the same rights and permissions that the user has in the IXM Platform. For example, if the user is not an admin, you can’t query the rights of other users.

Get your session ID

Learn how to retrieve your session ID in our tutorial.

Note

For security reasons, the session ID expires after a certain period of time.

API key

You can create an API key to perform tests with your personal IXM Platform user. When you use the key for authorization, you have the same rights and permissions that this user has in the IXM Platform.

Get your API key

To get your API key, perform the following steps:

1. Log into the IXM Platform as an administrator.

2. Go to Administration > Permissions.

3. In the User management pane, double-click on the user that you want to use with the API.

4. In the Edit user window, switch to the Api key tab.

5. Copy the available API key or create a new one to copy.