API-ключи

Ключи API позволяют одобренному внешнему приложению обмениваться информацией с вашим рабочим пространством Versafy (например, внутренним порталом поддержки или рабочим процессом отчетности) без использования входа в систему товарища по команде. Поскольку ключ предоставляет постоянный доступ, создавайте его только для известного приложения и владельца.

Навигация: Открыть Разное → Ключи API.

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

Создайте ключ API

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

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

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

Назовите клавиши четко.

Используйте такие имена, как Портал поддержки — производство или Экспорт отчетов — тест. Избегайте имен, содержащих пароли, сведения о клиентах или сам секрет.

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

Используйте ключи безопасно

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

Примеры запросов и доступные операции см. в справочнике по API Versafy вашей организации.

Отозвать ключ API

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

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

Устранение неполадок доступа к API

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

Отмените непригодный для использования ключ и создайте новый. Первоначальный секрет не может быть раскрыт снова.

Приложение теряет доступ

Убедитесь, что его ключ не был отозван, настроен правильный ключ рабочей области и запрошенная операция клиентского API доступна для этой интеграции.