To generate an API key in OZmap, the first step is to create a new user. It is essential to use a dedicated user for this purpose, as the user will lose access to OZmap once the key is generated. Click here to learn more about the user creation process.

Access

In the left side menu, click Users.

How to generate the key

  1. Open the API user. If it does not exist yet, create a new one with the New user button.
  2. In Modules, check API. If the user also needs to access OZmap, keep OZmap checked.
  3. Save the user.
  4. Scroll down to the API Configuration section and click Generate a token.
  5. A warning informs that users with an API key have access to the system limited to API use. Confirm with OK.
  6. The user's clientId and clientSecret are then displayed.

About the clientId and clientSecret

  • The clientId is a code generated by the system. It is no longer the user's name.
  • The clientSecret is displayed only once. Copy it and store it in a safe place, as it will not be possible to view it again.
  • If the clientSecret is lost, use the regenerate button to create a new one. The previous one stops working.
  • The copy button next to the clientSecret copies the value to the clipboard.

Before you begin

The user must have the API module checked. Without it, the system displays the message "The user does not have access to the API".