Ключі API

Ключі API дозволяють схваленій зовнішній програмі обмінюватися інформацією з вашою робочою областю Versafy, наприклад, внутрішнім порталом підтримки або робочим процесом звітності, без використання входу члена команди. Оскільки ключ надає постійний доступ, створіть його лише для відомої програми та власника.

Навігація: відкритий Різне → Ключі API.

Сторінка відображається лише для користувачів, яким дозволено керувати ключами API.

Створіть ключ API

Створіть окремий ключ для кожної програми та середовища, щоб ви могли визначити його призначення та відкликати його, не перериваючи непов’язану роботу.

Виберіть Новий ключ API.
Введіть чітку назву, яка ідентифікує програму та середовище.
Створіть ключ.
Скопіюйте його негайно.
Зберігайте його в затвердженому менеджері паролів або секретному сховищі розгортання.

Повний секрет показується лише один раз. Versafy не зможе відобразити його знову пізніше.

Чітко називайте ключі

Використовуйте такі імена, як Портал підтримки — виробництво або Експорт звітності — тест. Уникайте імен, які містять паролі, дані клієнтів або сам секрет.

Створіть окремі ключі для окремих програм і середовищ. Це дає змогу скасувати одну інтеграцію, не перериваючи інші.

Використовуйте ключі безпечно

Ніколи не розміщуйте ключ в інструкціях агента, базі знань, знімках екрана, повідомленнях чату або вихідному коді, закріпленому в сховищі.
Ніколи не використовуйте веб-переглядач або загальнодоступне місце розташування веб-сайту, де відвідувачі можуть його перевірити.
Діліться ним лише через схвалений процес керування секретами.
Розглядайте скопійовані журнали та звіти про помилки як потенційно конфіденційні.

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

Відкликати ключ API

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

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

Усунення несправностей доступу до API

Ключ не скопійовано

Відкликайте непридатний ключ і створіть новий. Початкову таємницю неможливо розкрити знову.

Програма втрачає доступ

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