API-ключи
API-ключ - это доступ к данным вашей организации для внешних систем: 1С, BI-панели, собственного сайта или любой другой интеграции, которую пишет разработчик. Ключ не для сотрудников, а для программ, которые обращаются к Smengo напрямую.
Где создать ключ
Управлять ключами может участник с правом «Управление организацией» - обычно это владелец. Раздел находится в «Настройки» → «Интеграции» → блок «API-ключи».
Как создать ключ
- Нажмите «Создать ключ».
- Введите название - оно только для вас, чтобы отличать ключи между собой (например, «Интеграция с 1С»).
- Отметьте доступ (скоупы) - какие данные ключ сможет читать: сотрудники, график, чекины, табель или спрос/выручка. Отмечайте только то, что действительно нужно интеграции.
- При желании укажите лимит запросов в минуту (по умолчанию 60).
- Нажмите «Создать».
Ключ может получить доступ только к тем данным, которые видите вы сами - если у вас нет какого-то права, ключ тоже не сможет его получить.
Скопируйте ключ сразу - второй раз он не покажется
Сразу после создания ключ показывается на экране ровно один раз. Нажмите «Скопировать» и сохраните его в надёжном месте, прежде чем закрыть окно. Smengo хранит только зашифрованный отпечаток ключа - открыть его повторно нельзя, только отозвать и создать новый.
Ключ - это секрет, как пароль. Не публикуйте его, не отправляйте в открытых чатах и не вставляйте в код, который видят посторонние. Передавайте его только тому, кто настраивает интеграцию, и только по защищённому каналу.
Отзыв ключа
В любой момент можно отозвать ключ кнопкой «Отозвать» в списке - все запросы с ним сразу перестанут работать. Отзывайте ключ, если интеграция больше не нужна или если есть подозрение, что ключ куда-то утёк.
Для разработчиков
Технические детали - формат ключа, все доступные скоупы, эндпоинты и примеры запросов - в документации по API. Эту ссылку можно передать тому, кто пишет интеграцию.