Authentication
All API requests must be authenticated using an API key. The API key should be included in the Authorization
header as a Bearer token. Example: Authorization: Bearer <YOUR_API_TOKEN>
Obtaining an API Key
API keys can be generated from the Summit application:
- Log in to your Summit account.
- Navigate to Settings.
- Go to the API Tokens tab.
- Click on "Generate New Token".
- Provide a name for your token and click "Generate Token".
- Important: Copy the generated token immediately. You will not be able to see it again.
The token will look like skt_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx
.
Authentication Process
Include your API token in the Authorization
header for every request. Here's the format:
Authorization Header Format
Authorization: Bearer skt_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx
Always keep your token safe and reset it if you suspect it has been compromised.
Common Headers
For the Summit API, you should include these headers in your requests:
Authorization
: Bearer token for authentication.Content-Type
: Should beapplication/json
for requests with a JSON body (e.g., POST, PUT).
Base URL
The base URL for all API endpoints is:
https://your-summit-instance.com
(Replace your-summit-instance.com
with your actual Summit instance URL).
All API paths are prefixed with /api
.