Использование ArcGIS Earth Automation API

Включение ArcGIS Earth Automation API

Чтобы активировать ArcGIS Earth Automation API и обеспечивать коммуникацию с ArcGIS Earth, проверьте Включить Automation API в Расширенных настройках приложения. После включения станут доступны и будут отображены ниже ссылки на страницу с примерами ArcGIS Earth Automation API и страницу справки.

Конфигурация

Вы можете настроить ArcGIS Earth Automation API с помощью файла конфигурации settings.json. Файл конфигурации settings.json обычно находится в папке C:\Program Files\ArcGIS\Earth\bin\automation и автоматически копируется в папку пользователя Documents/ArcGISEarth/automation при запуске ArcGIS Earth. Таким образом пользователи могут настроить ArcGIS Earth Automation API с помощью файла конфигурации settings.json.

Функция autoStart автоматически включает ArcGIS Earth Automation API при запуске ArcGIS Earth. Значение по умолчанию равно false. Если оно равно autoStart=true, ArcGIS Earth создает .NET Generic Host и запускает веб-сервис с имплементацией сервера HTTP на вашем локальном компьютере при запуске. Проверьте статус ArcGIS Earth Automation API в Расширенных настройках приложения и использовать его напрямую.

Если вы пользуетесь приложением в первый раз, можно применить параметр autoStart импортированного файла конфигурации для управления переключателем API в Расширенных настройках приложения.

Примечание:

  • ArcGIS Earth Automation API в первую очередь использует файл конфигурации settings.json в вашей папке.
  • Параметр autoStart в файле конфигурации работает только при первой установке ArcGIS Earth.

Настраиваемые параметры API автоматизации

ArcGIS Earth Automation API работает из коробки без дополнительной настройки. Однако если вам нужно изменить значения по умолчанию, необходимо понимать действие разных параметров конфигурации.

ПараметрОписание
autoStart

Включает ArcGIS Earth Automation API при запуске ArcGIS Earth. Значением по умолчанию является false.

baseUrl

Задает URL, который будет слушать ArcGIS Earth Automation API. По умолчанию – http://localhost:8000.

Подсказка:
  • Поддерживается только протокол HTTP.
  • Хост baseUrl по умолчанию – localhost. Вы можете также использовать локальный IP-адрес или имя хоста, если хотите, чтобы доступ к ArcGIS Earth Automation API мог выполняться из-под другой учетной записи.
  • ArcGIS Earth Automation API поддерживает кросс-доменную публикацию ресурсов (CORS) из всех источников по схеме HTTP и допускает использование метода HTTP. Настройки разрешенных источников и разрешенных HTTP-методов пока не поддерживаются. Подробную информацию вы найдете в разделе Опции политики CORS в ASP.NET Core.

webRoot

Задайте корневую веб-директорию ArcGIS Earth Automation API. Этот пункт является необязательным. Корневая веб-директория по умолчанию находится в папке Documents/ArcGISEarth/automation.

Подсказка:
  • Корневая веб-папка задает относительный путь к статическим ресурсам приложения. Если путь не существует, используется поставщик файлов без операций. Для получения подробной информации см. раздел WebRoot.

Подключение к ArcGIS Earth

После запуска ArcGIS Earth Automation API клиентское приложение может начать коммуникацию с ArcGIS Earth через RESTful Automation API.

Для работы с ArcGIS Earth Automation API, вам необходимо понимать, как создать URL-адрес и как интерпретировать ответ. Все операции ArcGIS Earth Automation API выполняются через иерархию точек доступа.

При помощи Automation API вам для отправки запросов нужен конкретный адрес точки доступа. Точка доступа по умолчанию – http://localhost:8000/arcgisearth/<controller>. Например, чтобы получить информацию о камере ArcGIS Earth, нужен следующий URL:

http://localhost/arcgisearth/camera

Проверьте статус ArcGIS Earth Automation API в Расширенных настройках приложения и воспользуйтесь страницей примера в браузере либо посетите ArcGIS Earth Automation API GitHub, чтобы получить подробную информацию.