API Ключ-АСТРОМ: различия между версиями

Материал из Документация Ключ-АСТРОМ
Строка 2: Строка 2:


== Основное ==
== Основное ==
[[Аутентификация (API)]]<br>
[[Токены и аутентификация (API)]]<br>
[[Коды ответа (API)]]<br>
[[Коды ответа (API)]]<br>
[[Ограничение доступа (API)]]<br>
[[Ограничение доступа (API)]]<br>
[[Предпросмотр и бета версии (API)]]<br>
[[Предпросмотр и бета версии (API)]]<br>


== Эндпоинты ==
== Эндпоинты ==

Версия 10:01, 3 декабря 2021

Используйте Ключ-АСТРОМ API для автоматизации задач мониторинга и экспорта различных типов данных в сторонние инструменты отчетности и анализа. Обмен данными через API обеспечивает безопасность за счет использования защищенного обмена данными по протоколу HTTPS.

Основное

Токены и аутентификация (API)
Коды ответа (API)
Ограничение доступа (API)
Предпросмотр и бета версии (API)

Эндпоинты

Эндпоинты среды

Информация о кластере

Информация о кластере

Эндпоинты конфигурации

API Explorer

Вы можете получить доступ ко всем конечным точкам API Ключ-АСТРОМ с помощью API Explorer.

  1. Выберите Настройки в меню навигации.
  2. Перейдите в Интеграция> Ключ-АСТРОМ API .
  3. Кликните ссылку Ключ-АСТРОМ API Explorer вверху страницы.

В качестве альтернативы вы можете получить доступ к API Explorer по прямой ссылке: https://{ваш-домен}/e/{id-среды}/rest-api-doc/


Аутентификация в API Explorer

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

Вы также можете разблокировать все эндпоинты, выбрав Авторизовать . В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой API токен в диалоговое окно Доступные авторизации , вы можете разблокировать все связанные эндпоинты API.


Попробуйте сделать вызов API

После того, как вы ввели свой токен API, вы можете напрямую выполнять вызовы API в проводнике API. Клик по кнопке «Попробовать» открывает раздел параметров выбранного эндпоинта API, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «Выполнить» .