API-ключи

По API-ключу ваш скрипт или внешний сервис обращается к данным Sumvest от вашего имени.

API-ключи есть только на тарифе Pro. Активных ключей может быть до пяти.

Когда нужны

• Скрипт, который раз в день добавляет строки в таблицу.
• Связка с вашими инструментами: Telegram-бот, таблица Google, учётная программа.
• Регулярная выгрузка данных себе на сервер.

Создать ключ

1. Настройки → API ключи → «Новый ключ».
2. «Название»: чтобы различать ключи, например «ETL-скрипт». Его видите только вы.
3. «Права доступа»: что ключ может:
   • «Чтение datasets»: читать таблицы и строки;
   • «Изменение datasets»: создавать и менять таблицы и строки;
   • «Чтение дашбордов»;
   • «Изменение дашбордов»;
   • «Чтение профиля».
4. «Создать ключ».
5. Скопируйте ключ сразу: он показывается один раз. После закрытия окна восстановить его нельзя.

Создавайте отдельный ключ под каждый скрипт: так проще отозвать один, не трогая остальные.

Отозвать ключ

«Отозвать» напротив ключа → подтвердите. Скрипты с этим ключом перестанут работать сразу. Вернуть отозванный ключ нельзя, создайте новый.

Если подписка закончилась, ключи можно посмотреть и отозвать, но не создать.

Как использовать

Передавайте ключ в заголовке каждого запроса:

Authorization: Bearer inv_live_…

Адрес API: https://app.sumvest.ru/api/v1. Методы, права и лимиты описаны в «HTTP API для интеграций».

Безопасность

• Не публикуйте ключ в открытом коде, на форумах и в чатах.
• Если ключ утёк, сразу отзовите его и создайте новый.
• Давайте минимум прав. Интеграции, которая только читает, не нужны права на изменение.
• Сервер хранит не сам ключ, а его отпечаток. Даже мы не можем его восстановить.

Частые ошибки

• Не сохранили ключ. Отзовите его и создайте новый.
• Ключ не даёт записать строку. Не хватает права «Изменение datasets».
• Кнопка создания недоступна. API-ключи есть только на Pro. См. «Подписка и оплата».

Что дальше

• HTTP API для интеграций
• Безопасность
• Выгрузка данных