Developer Program Documentation
Preamble
Cortlet is a software brand specailizing in: Lightweight, secure-first, no-bloat, problem-solving, and balance of opensource and closed source software.
This Developer Program Documentation includes instructions to login, create API keys, etc.
This Documentation helps developers who joined for the first time, get used to the Developer Program.
You are going to learn:
how to create an account
how to create an organization
API Keys
and more...
The Developer Program is a program for developers to use Cortlet APIs, via a single API Key. It is free at no yearly cost.
Creating an account
Using the developer program requires one account. For API keys, and team management, an organization is required.
Creating accounts is easy. You have two options:
Using Email/Password (requires registering)
Using Google/GitHub (does not require signup/registration)
For the ease of setup, we will select GitHub.
First, click on the link:
You should be able to see Google and GitHub options, click "Continue with GitHub". When clicked, you should be able to see:
"Authenticate Cortlet Developer with [your account]?"
Click Yes.
After clicking yes, a delay (for CAPTCHA) may happen. This is normal, so wait patiently.
After logging in, you should be able to see a page to create an organization, click "Create".
If the account already has an organization, make sure you have selected the correct account and have not deleted that organization.
Creating an organization
To create an organization, you can either Skip and create it in the dashboard. We will not skip and create it.
Prerestiquites:
A logo
Team member's emails (optional)
First, upload your logo.
The recommended is to follow the size limit displayed, and it's recommended that the logo is visible at dark and light mode.
Now, type a name for your organization, then add emails for your team members (optional step)
Now, your organization is created. You will be redirected to the dashboard where you can manage API keys, etc.
Developer
Creating API Keys
API Keys add functionality for Cortlet APIs (e.g. RootCauseni), as one single API key = universal access to all APIs.
For future SDKs, they might require API Keys also, as Cortlet SDKs may have a few APIs.
Creating API Keys is an easy process. The format of a Cortlet API key is:
ct_live_<random-hash>
Now, to create an API Key, you need to have an organization and that you are inside the organization dashboard.
First, when you are in the Organization Dashboard, you should be able to see:
"API Keys"
"Manage your API Keys."
Click on the button "Manage API Keys".
You will be redirected to the API Keys dashboard, which includes the list of API Keys. If you don't have one, click "Generate API Key". (note: you won't see your revoked/deleted API Keys.)
When generated, you should be able to see the API Key, Make sure you copy it.
⚠️ Warning: Copy it immediately, it won't be visible later.
After copying, set it as an Environment variable (.env) or run the command:
setx CORTLET_API_KEY "ct_live_<your-key>"
Or, if you prefer manual .env file:
CORTLET_API_KEY=ct_live_<your-api-key>
Best Security/Cleanup/Common Practices for API Keys
Rotate Keys regularly
Revoke keys when leaked in code/stolen and used by someone immediately.
Store keys as env var (or secret manager software/website), never hardcore it.
Never share your API Key to anyone. Cortlet will never ask you to share your API key.
Delete unused keys.
Check Key usage routinely.
To rotate a key, you can delete the API key and then regenerate the API key again.
To check Key usage, you can go to your API Key dashboard -> click "Usage Analytics".