Создание ключа
- Откройте Настройки, затем Ключи API, и выберите Создать ключ.
- Назовите ключ по системе, которая будет его использовать. Выберите область доступа и, при желании, срок действия.
- Скопируйте ключ сейчас и сохраните его в хранилище секретов своей системы.
Important: Полный ключ показывается один раз. Если вы его потеряете, отзовите его и создайте новый.
| Область доступа | Действует как |
|---|---|
| Только чтение | Наблюдатель. Может читать то же, что и наблюдатель. |
| Чтение и запись | Не выше управляющего. Может создавать и изменять то же, что и управляющий. |
Использование ключа
Передавайте ключ в заголовке Authorization каждого запроса к API приложения:
Authorization: Bearer ehk_...
- Ключ работает только для своей организации и только в пределах своей области доступа.
- При использовании ключа заголовок CSRF не нужен.
- Ключ не может создавать другие ключи или управлять ими.
- Запросы, выполненные с ключом, записываются в журнал аудита от имени ключа API.
Отозвать
Выберите Отозвать у ключа, и он сразу перестанет работать, а использующие его системы будут получать ошибки 401. Ключ также перестаёт работать, когда создавший его сотрудник покидает организацию. В списке видно, когда каждый ключ использовался последний раз.
Tip: По возможности выдавайте каждой интеграции отдельный ключ только для чтения. Если ключ утечёт, вы отзовёте только его.
Чтобы получить описание API для ваших разработчиков, напишите нам через форму обратной связи.