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