Resources
/
API
/
Chekhub API Key Generation Guide
API
Chekhub API Key Generation Guide
Learn how to create API keys to integrate with Chekhub's platform.
Still stuck?
Our support team can walk you through it
Overview
This guide provides step-by-step instructions for generating API keys to integrate with Chekhub's platform.
API Documentation Reference
Generating Your API Key
Option 1: Without SSO or SSO Not Enforced
If your organization does not have Single Sign-On (SSO), or has SSO enabled but not enforced, follow these steps:
Step 1: Create a Service Account
We recommend creating a dedicated member account to serve as your API service account. This ensures all API actions are properly attributed in the system (e.g., "Ticket created by API Service Account").
Navigate to your Chekhub Admin Panel
Create a new member with an appropriate email address (e.g., api-service@yourcompany.com)
Have someone with access to that email accept the invitation and create a password
Step 2: Generate the API Key
Follow the API Key Generation Instructions in the API documentation. You'll need to provide:
Username: Service account email address
Password: Password created for the service account
Role: The role from your organization's role matrix (available in the Admin Panel). This determines which privileges and actions the API key is permitted to perform.
Option 2: SSO Enforced
If your organization requires SSO for all members, Chekhub will generate the API key on your behalf.
Please provide the following information to your Chekhub Support or Account Manager:
Service Account Email: The email address for the member/service account the API key will be associated with
Role: The name of the role from your organization's role matrix (available in the Admin Panel). This determines which privileges and actions the API key is permitted to perform.
Questions or Support
For assistance with API key generation or integration, please contact support@chekhub.com.
