API-ключи

Использование API-ключа

Чтобы настроить интеграцию с вашей организацией в eSputnik, используйте API-ключ.

eSputnik API поддерживает Basic HTTP Access Authentication с использованием API-ключа.

Ключ дает доступ к данным из вашей учетной записи eSputnik, поэтому он должен быть защищен от несанкционированного доступа.

Чтобы авторизоваться и обратиться к ресурсам вашего аккаунта в eSputnik:

• введите любое значение для username;
• введите значение вашего API-ключа в поле password.

Пример авторизации с помощью API ключа для приложения Postman:

Создание API-ключа

1. Перейдите в раздел “Настройки”, затем выберите вкладку API и нажмите кнопку “Новый ключ”.

2. В поле "Описание" можно добавить информацию о том, какое именно приложение/сайт будет использовать этот ключ для доступа к вашему аккаунту в eSputnik. Это поможет в будущем легко идентифицировать данный API-ключ.

3. Откройте список и выберите права доступа для ключа API.

4. Если нужно настроить несколько интеграций, вы можете создать ключ для каждой из них. Также для одной организации можно создать несколько ключей с разными правами доступа.

Вы можете найти все API-ключи на вкладке API. Каждый ключ содержит следующую информацию:

A. Собственно ключ (в скрытом виде), его можно скопировать, просто кликнув по нему
B. Кем создан ключ
C. Дата его создания
D. Права доступа
E. Описание
F. Статус (активен/неактивен).

Права доступа

Доступ с API-ключом к ресурсам eSputnik устанавливается на этапе создания ключа. Вы можете дать полный доступ ко всем ресурсам и методам eSputnik API, выбрав опцию Full access to API, или ограничить его, выбрав:

• Access to events
• Access to events and contacts
• Access to events and contacts (adding/updating)
• Access to messages

Копирование ключа

Чтобы скопировать ключ:

• Наведите курсор на номер ключа, чтобы появилась иконка “Копировать”.
• Кликните иконку “Копировать”.

Активация и деактивация ключа

Ключ создается активным по умолчанию.

Чтобы деактивировать его:

1. Переместите ползунок напротив ключа в положение "Отключить ключ".

2. Подтвердите действие во всплывающем окне.

Ключ будет деактивирован

Редактирование ключа

1. Кликните меню “Опции” (...) справа.

2. Выберите из списка пункт “Редактировать”.

3. Отредактируйте описание и/или права доступа и нажмите “Сохранить”.

Удаление ключа

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

Чтобы удалить ключ:

1. Кликните меню “Опции” (...) справа.

2. Выберите “Удалить” из списка.

3. Подтвердите действие во всплывающем окне.

Безопасность API-ключа

API-ключи предоставляют доступ к данным вашей учетной записи eSputnik и должны быть защищены так же, как и ваш пароль. В частности, существует несколько распространенных сценариев, которые следует учитывать при работе с API-ключами.

1. Не допускайте, чтоб ключ был виден на скриншотах или демо-видео. Затирания ключа может быть недостаточно — лучше “вырезать” его в графическом редакторе.
2. Не отправляйте API-ключ по почте, так как если ваш почтовый аккаунт взломают, данные в eSputnik окажутся под угрозой.

Если вы заметили необычную, подозрительную или незнакомую активность в своей учетной записи, возможно, кто-то другой использует ваш ключ API без разрешения.

Выключите или удалите скомпрометированный ключ и создайте новый.