A key gives access to your channel’s data only. In API requests and responses, the key is called a token: hence error codes such as invalid_token. You can issue one in the dashboard, in the «Разработчикам» (Developers) section. The dashboard is in Russian, so its buttons are quoted as they appear there, with a translation.
| Secret key | Public key | |
|---|---|---|
| Used by | a bot, a server, a script | the code of a web page |
| Reads | the data its scopes allow, including donations | profile, goals and stats; not donations |
| Lifetime | 30, 90 or 365 days | no expiry |
| Value | we show it once | can be copied again |
Issue a key
Section titled “Issue a key”Secret. In the «Секретные ключи» (Secret keys) block, press «Выпустить секретный ключ» (Issue secret key), set a name, scopes and lifetime, and press «Выпустить ключ» (Issue key). Copy the value right away: you cannot view it later.
Public. In the «Публичный ключ» (Public key) block, press «Выпустить публичный ключ» (Issue public key), enter your website address and press «Выпустить ключ» (Issue key).
Open Developers in your dashboardSecret key scopes
Section titled “Secret key scopes”| In the dashboard | Scope | Opens |
|---|---|---|
| «Профиль» (Profile) | profile:read |
nickname, name, avatar, donation page link |
| «Донаты» (Donations) | donations:read |
full donations, including ones rejected by moderation |
| «Цели» (Goals) | goals:read |
goals and amounts raised |
| «Статистика» (Stats) | stats:read |
top donors and the total for a period |
Tick only what you need: scopes cannot be changed after the key is issued.
Keep the secret key on the server
Section titled “Keep the secret key on the server”Store it in an environment variable or in the bot settings. Never put it into website code, a repository, a chat or OBS: anyone who has it can read your data.
The public key can live in website code. It works only from the addresses listed in its settings.
Replace a secret key
Section titled “Replace a secret key”A lifetime cannot be extended. To keep the bot running:
- Issue a new key.
- Update your bot to use the new key, then send a test request.
- Delete the old one. Deletion takes effect within a minute.
If a key leaked, issue a new one and delete the old one right away.
How many keys you can have
Section titled “How many keys you can have”Up to 20 active keys, the public key included. Expired keys do not count and stay in the list marked «Истёк» (Expired) until you delete them.