En utilisant ArcGIS Earth Automation API

Activer ArcGIS Earth Automation API

Pour activer ArcGIS Earth Automation API et communiquer avec ArcGIS Earth, cochez Enable Automation API (Activer l’API d’automatisation) dans les paramètres Advanced (Avancé) de l’application. Une fois le paramètre activé, les liens vers la page d’exemple et la page d’aide ArcGIS Earth Automation API sont accessibles et répertoriés ci-après.

Configuration

Vous pouvez configurer ArcGIS Earth Automation API à l’aide du fichier de configuration settings.json. Le fichier de configuration settings.json se trouve généralement dans le dossier C:\Program Files\ArcGIS\Earth\bin\automation et est copié automatiquement dans le dossier Documents/ArcGISEarth/automation de l'utilisateur au démarrage de ArcGIS Earth. Ainsi, les utilisateurs peuvent configurer ArcGIS Earth Automation API à l’aide du fichier de configuration settings.json.

La fonction autoStart active automatiquement ArcGIS Earth Automation API au démarrage de ArcGIS Earth. La valeur par défaut est false. Lorsque autoStart=true, ArcGIS Earth crée un hôte générique .NET et démarre un service Web avec une implémentation de serveur HTTP sur votre machine locale au démarrage. Vérifiez le statut de ArcGIS Earth Automation API dans les paramètres Advanced (Avancé) de l’application.

Pour l’utilisateur débutant, vous pouvez utiliser le paramètre autoStart du fichier de configuration importé pour contrôler le commutateur API dans les paramètres Advanced (Avancé) de l’application.

Remarque :

  • ArcGIS Earth Automation API utilise d'abord le fichier de configuration settings.json qui se trouve dans votre répertoire.
  • Le paramètre autoStart du fichier de configuration fonctionne uniquement pour la première installation de ArcGIS Earth.

Paramètres configurables de l’API d’automatisation

ArcGIS Earth Automation API est prêt à l’emploi sans configuration spéciale. Cependant, si vous avez besoin de modifier les valeurs par défaut, il est nécessaire de comprendre les différents paramètres de configuration.

ParamètreDescription
autoStart

Active ArcGIS Earth Automation API au démarrage de ArcGIS Earth. Par défaut, cette propriété est définie sur faux.

baseUrl

Définit l’URL qui sera écoutée par ArcGIS Earth Automation API. La valeur par défaut est http://localhost:8000.

Conseil :
  • Seul le protocole de type HTTP est pris en charge.
  • L’hôte par défaut de baseUrl est localhost. Vous pouvez également utiliser l’adresse IP locale ou le nom d’hôte si vous souhaitez que ArcGIS Earth Automation API puisse être accessible depuis une autre origine.
  • ArcGIS Earth Automation API autorise les demandes CORS (Cross-Origin Resource Sharing) de toutes origines avec une structure HTTP et autorise toute méthode HTTP. Les paramètres des origines autorisées et des méthodes HTTP autorisées ne sont pas encore pris en charge. Pour plus d’informations, reportez-vous à la rubrique CORS policy options in ASP.NET Core.

webRoot

Spécifie le répertoire racine Web utilisé par ArcGIS Earth Automation API. Ce paramètre est facultatif. Le répertoire racine Web par défaut se trouve dans votre dossier Documents/ArcGISEarth/automation.

Conseil :
  • La racine Web détermine le chemin relatif vers les ressources statiques de l’application. Si le chemin n’existe pas, un fournisseur de fichiers no-op est utilisé. Pour plus d’informations, reportez-vous à la page WebRoot.

Connexion à ArcGIS Earth

Une fois ArcGIS Earth Automation API démarrée, l’application client peut communiquer avec ArcGIS Earth via l’API d’automatisation RESTful.

Pour utiliser ArcGIS Earth Automation API, vous devez savoir comment créer une URL et interpréter la réponse. Toutes les opérations exposées par ArcGIS Earth Automation API sont accessibles via une hiérarchie d’extrémités.

Lorsque vous utilisez l’API d’automatisation, vous avez besoin d’une adresse d’extrémité spécifique pour l’envoi des requêtes. L’extrémité par défaut est http://localhost:8000/arcgisearth/<controller>. Par exemple, si vous souhaitez obtenir les informations de la caméra de ArcGIS Earth, l’URL est la suivante :

http://localhost/arcgisearth/camera

Vérifiez le statut de ArcGIS Earth Automation API dans les paramètres Advanced (Avancé) de l’application et utilisez la page exemple dans votre navigateur, ou consultez la page GitHub ArcGIS Earth Automation API pour plus de détails.