Step 1 – Log in as an administrator
API access is an admin level setting. You need to be logged in as an administrator before you can turn it on.
Step 2 – Turn on public API access
- Go to Settings
- Scroll down to API Access
- Enable Public API
- Once it’s on, your API key appears on the same screen.
Step 3 – Find your API key
Your API key is what other systems use to authenticate with GembaDocs. You’ll need it any time you set up a new integration, so keep it somewhere secure.
Step 4 – Open the API documentation
Select View Documentation to open the full set of docs. This is where you’ll find:
- A complete overview of available endpoints
- API calls for working with SOPs
- API calls for working with skills matrices
- API calls for other GembaDocs features
- Everything is structured so a developer can pick it up and start building without a lot of back and forth.
Step 5 – Use an AI coding assistant to move faster
A lot of GembaDocs customers hand the API documentation straight to an AI coding assistant before they start development. The assistant can:
- Read through the available endpoints
- Map out how GembaDocs should connect to existing software
- Generate example code to get started
- This step is optional, but it can cut a lot of time off the integration process.
Tips and common mistakes:
- You need administrator access to enable the API. If you don’t see the setting, check your permissions first.
- Keep your API key private. Anyone with the key can access your GembaDocs data through the API.
- If you need an endpoint that isn’t there yet, send your suggestion to support@gembadocs.com. The team reviews requests for future releases.