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

Материал из Документация Ключ-АСТРОМ
Строка 5: Строка 5:
* [[Предпросмотр и бета версии (API)]]
* [[Предпросмотр и бета версии (API)]]


== Эндпойнты среды ==
== Эндпоинты среды ==
* АктивныеШлюзы
 
** Информация об АктивныхШлюзах
=== АктивныеШлюзы ===
*** [[Получить информацию о всех АктивныхШлюзах]]
* Информация
*** [[Получить информацию о конкретном АктивномШлюзе]]
** [[Получить информацию о всех АктивныхШлюзах]]
** Конфигурация автообновления АктивныхШлюзов
** [[Получить информацию о конкретном АктивномШлюзе]]
***[[Получить глобальную конфигурацию]]
* Конфигурация автообновления
***[[Редактировать глобальную конфигурацию]]
**[[Получить глобальную конфигурацию]]
***[[Получить АктивныйШлюз]]
**[[Редактировать глобальную конфигурацию]]
***[[Редактировать АктивныйШлюз]]
**[[Получить АктивныйШлюз]]
** Задания автоматического обновления АктивныхШлюзов
**[[Редактировать АктивныйШлюз]]
***[[Получить все задания автообновления]]
* Задания автообновлений
***[[Получить конкретное задание автообновления]]
**[[Получить все задания автообновления]]
***[[Разместить задание автообновления]]
**[[Получить конкретное задание автообновления]]
***[[Удалить задание автообновления]]
**[[Разместить задание автообновления]]
***[[Получение АктивныхШлюзов с автообновлением заданий]]
**[[Удалить задание автообновления]]
*Анонимизация
**[[Получение АктивныхШлюзов с автообновлением заданий]]
 
=== Анонимизация ===
**[[Выполнение задания анонимизации]]
**[[Выполнение задания анонимизации]]
**[[Получить статус анонимизации]]
**[[Получить статус анонимизации]]

Версия 15:07, 13 сентября 2022

Основное

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

АктивныеШлюзы

Анонимизация

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

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

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, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «Выполнить» .