Overview
An API key is a secure token that lets you authenticate your requests to the Nimble REST APIs. Using this key, you can programmatically access Nimble data — such as Users, Projects, and Team Members — from your own applications or integration tools, without signing in through the web interface each time.
You generate the key from the API Key Generation screen, set an expiry date for it, and then use it to authorize your API calls.
Navigation
In the left panel, select Account Space. Then, from the top panel, go to Administration and select API Key Generation.
Generate an API Key
The API Key Generation screen opens with an Expiry date field and the Generate API Key button.
- Click the Expiry date field and select the date on which you want the key to stop working. The key remains valid until the end of this date.
- Click Generate API Key.
- Your new personal access API key is generated and displayed. Click the Copy icon next to the key and store it in a safe place.
How It Works
The generated key is shown only once, at the time of generation. For security, Nimble does not store or display it again — so make sure you copy and save it before leaving the screen. If you lose the key, generate a new one.
The key stays active until the expiry date you set. After that date, any request made with the key is rejected, and you need to generate a new key to continue.
Use the API Key with the Nimble REST APIs
Once you have your API key, you can use it to explore and run the Nimble REST APIs from the interactive API documentation (Swagger) page:
https://nimble.digite.com/apidocs/v2/saas/
The Swagger page lists all available APIs — such as User, Project, and Team Members — and lets you try them directly from the browser. To use it:
- Open the Swagger page using the link above.
- Click Authorize and paste the API key you copied from Nimble. This authenticates all the requests you make from this page.
- Expand the API you want to use (for example, Users) and select the specific endpoint.
- Click Try it out, fill in any required parameters, and click Execute.
- Review the response returned by Nimble, including the request URL, response body, and status code.
This makes it easy to test how each API behaves before using it in your own application or integration.
Integration Levels
Nimble supports integration at two levels:
- System-level integration — managed centrally and not tied to an individual user.
- Project-level integration — specific to a project’s configuration.
The REST APIs and the API key you generate here are used to build these integrations. Additional integration capabilities are planned for future releases.
Important Points
- The API key is displayed only once. Copy and store it securely as soon as it is generated.
- The key is a personal access key — it carries your access permissions, so treat it like a password and do not share it.
- Set an appropriate expiry date. Once the key expires, generate a new one to continue accessing the APIs.
- Use the key only over secure (HTTPS) connections when calling the Nimble REST APIs.