API Ключ-АСТРОМ: различия между версиями
DKashanov (обсуждение | вклад) |
DKashanov (обсуждение | вклад) |
||
Строка 9: | Строка 9: | ||
== Эндпоинты == | == Эндпоинты == | ||
=== | === Эндпоинты среды === | ||
==== Информация о кластере ==== | |||
[[Информация о кластере]] | |||
=== Эндпоинты конфигурации === | === Эндпоинты конфигурации === | ||
Строка 26: | Строка 27: | ||
Аутентификация в API Explorer<br> | Аутентификация в API Explorer<br> | ||
Выберите значок замка рядом с любым эндпоинтом, чтобы отобразить информацию о токенах API, которые защищают этот эндпоинт. Каждый эндпоинт требует определенного типа токена. | Выберите значок замка рядом с любым эндпоинтом, чтобы отобразить информацию о токенах API, которые защищают этот эндпоинт. Каждый эндпоинт требует определенного типа токена. | ||
Вы также можете разблокировать все эндпоинты, выбрав '''Авторизовать''' . В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой API токен в диалоговое окно '''Доступные авторизации''' , вы можете разблокировать все связанные эндпоинты API. | Вы также можете разблокировать все эндпоинты, выбрав '''Авторизовать''' . В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой API токен в диалоговое окно '''Доступные авторизации''' , вы можете разблокировать все связанные эндпоинты API. | ||
Попробуйте сделать вызов API | |||
Попробуйте сделать вызов API<br> | |||
После того, как вы ввели свой токен API, вы можете напрямую выполнять вызовы API в проводнике API. Клик по кнопке «'''Попробовать'''» открывает раздел параметров выбранного эндпоинта API, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «'''Выполнить'''» . | После того, как вы ввели свой токен API, вы можете напрямую выполнять вызовы API в проводнике API. Клик по кнопке «'''Попробовать'''» открывает раздел параметров выбранного эндпоинта API, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «'''Выполнить'''» . |
Версия 07:55, 3 декабря 2021
Используйте Ключ-АСТРОМ API для автоматизации задач мониторинга и экспорта различных типов данных в сторонние инструменты отчетности и анализа. Обмен данными через API обеспечивает безопасность за счет использования защищенного обмена данными по протоколу HTTPS.
Основное
Аутентификация (API)
Коды ответа (API)
Ограничение доступа (API)
Предпросмотр и бета версии (API)
Эндпоинты
Эндпоинты среды
Информация о кластере
Эндпоинты конфигурации
API Explorer
Вы можете получить доступ ко всем конечным точкам API Ключ-АСТРОМ с помощью API Explorer.
- Выберите Настройки в меню навигации.
- Перейдите в Интеграция> Ключ-АСТРОМ API .
- Кликните ссылку Ключ-АСТРОМ API Explorer вверху страницы.
В качестве альтернативы вы можете получить доступ к API Explorer по прямой ссылке: https://{ваш-домен}/e/{id-среды}/rest-api-doc/
Аутентификация в API Explorer
Выберите значок замка рядом с любым эндпоинтом, чтобы отобразить информацию о токенах API, которые защищают этот эндпоинт. Каждый эндпоинт требует определенного типа токена.
Вы также можете разблокировать все эндпоинты, выбрав Авторизовать . В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой API токен в диалоговое окно Доступные авторизации , вы можете разблокировать все связанные эндпоинты API.
Попробуйте сделать вызов API
После того, как вы ввели свой токен API, вы можете напрямую выполнять вызовы API в проводнике API. Клик по кнопке «Попробовать» открывает раздел параметров выбранного эндпоинта API, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «Выполнить» .