API-Створення та налаштування API-ключів | Підтримка eSputnik

Дані користувача

Email

Омніканальність

Автоматизація

Відстеження подій та поведінки

API-ключі

Використання API-ключа

Щоб налаштувати інтеграцію з вашою організацією в eSputnik, використовуйте API-ключ.

eSputnik API підтримує Basic HTTP Access Authentication з використанням API-ключа.

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

Щоб авторизуватися і звернутися до ресурсів вашого акаунта в eSputnik:

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

Приклад авторизації за допомогою API-ключа для застосунку Postman:

Postman

Створення API-ключа

1. Перейдіть до розділу "Налаштування", після чого виберіть вкладку API та натисніть кнопку "Новий ключ". 


Новий ключ

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

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

Налаштування доступу

Зверніть увагу

Правила доступу застосовуються до всіх версій методів (/v1, / v2 тощо), якщо не вказано інше.

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. Підтвердіть дію у спливаючому вікні.

ПідтвердженняКлюч буде деактивовано.

Зверніть увагу

Якщо ключ не використовується протягом 90 днів, він вимикається автоматично.

Редагування ключа

1. Натисніть меню “Опції” (...) праворуч.

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

Редагувати

3. Відредагуйте опис та/або права доступу та натисніть “Зберегти”.

Зберегти

Видалення ключа

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

Щоб видалити ключ:

1. Натисніть меню “Опції” (...) праворуч.

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

Видалення ключа

3. Підтвердіть дію у спливаючому вікні.

Підтвердження

Безпека API-ключа

API-ключі надають доступ до даних вашого облікового запису eSputnik і мають бути так само захищені, як і ваш пароль. Зокрема, існує кілька поширених сценаріїв, які слід ураховувати при роботі з API-ключами.

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

Якщо ви помітили незвичну, підозрілу або незнайому активність у своєму обліковому записі, можливо, хтось інший використовує ваш ключ API без дозволу.

Вимкніть або видаліть скомпрометований ключ та створіть новий.

Залишилися питання?
Спеціалісти обов'язково нададуть відповідь та допоможуть вирішити вашу проблему!
Зворотний дзвінок
Залишіть заявку – і наш спеціаліст зв'яжеться з вами в робочий час.
Відправити заявку
Консультація в чаті
Готові до ваших запитань!
Написати в чат
Електронна пошта
Напишіть в службу підтримки eSputnik.
Надіслати email