From the Profile Editing section of the Situm Dashboard, you can create and manage API keys according to your integration needs. API Keys allow you to use Situm REST API and Situm Mobile SDKs.
How to Create/Modify an API Key #
First, you must access the Profile menu on the Situm Dashboard:
Now, click on the “Create new API Key” button and a new API key will be created:
You can now click on the “Edit” button of the API Key to modify it’s permissions. You can also provide a description to better identify each API Key.
API Key permissions #
There are 5 types of API Keys in Situm, each with a greater level of permissions:
- Disabled: As the name suggests, this API Key is disabled for any kind of use.
- Positioning: With this API Key, you’ll be able to access basic data, such as venue cartography and the internal APIs that our location system uses. This is the API Key that you should normally use when integrating the Situm SDK in your mobile app.
- Only Read: Additionally, allows you to retrieve all the data, but not to modify it. This is the API Key that you should use, for instance, if you want to access the Reporting APIs, Realtime APIs, etc.
- Cartography Edition: Additionally, allows you to edit cartographic elements such as Geofences, POIs & Paths.
- Read & Write: Additionally, allows you to make any change, and obviously to read any data. This API should only be used for internal tasks and not be available to the final user.
Once you save the changes on the API Key, it will be updated and ready for use:
