Overview
All API requests require authentication using three headers. You’ll need to register your application first to get your App ID, and obtain API keys from your center’s settings.Required Headers
The ID you received when you registered your application. See the Create
App endpoint for registration details.
The API secret key provided by your center.
The API public key provided by your center.
Optional Headers
Specify the language/locale for localized responses. When provided, the API
will return humanized data in the requested language (e.g., status names,
role descriptions, formatted dates). Available locales: -
ro - Română
🇷🇴 - en - English 🇺🇸 - no - Norge 🇳🇴 - fr - French 🇫🇷 - de -
Deutschland 🇩🇪 - ru - Россия (Rossiya) 🇷🇺 - bg - България (Bulgariya) 🇧🇬uk- Україна (Ukrayina) 🇺🇦 -it- Italia 🇮🇹 -es- España 🇪🇸 If not provided, the API will use your center’s default language.
Getting Your API Keys
The keys provided by the center can be found in your center’s admin panel:- Navigate to General Settings → Other Settings
- On the top right, click the button leading to the API Secret Keys page
- You’ll find the API Public Key on the top right. That’s the center’s public key
- Next to it, there’s a button to create a new API Secret Key for each app that wishes to connect to your center’s account through the API
Each application should have its own secret key for security purposes.
Example Request Headers
The
X-LOCALE header is optional. When included, responses will be
localized to the specified language.
