Figure 34 Architecture des interfaces du Portail de découverte de GéoConnexions
La présente annexe explique comment vous pouvez améliorer vos propres applications à l'aide des interfaces de programmation d'application (API) de l'Infrastructure canadienne de données géospatiales (ICDG). Grâce aux API du Portail de découverte de GéoConnexions, vous pouvez offrir à vos utilisateurs un portail personnalisé leur permettant d'accéder aux catalogues de l'ICDG et d'y rechercher toutes les bases de données géospatiales distantes qui sont reliées à l'ICDG. Cette annexe :
décrit l'architecture des API du Portail de découverte de GéoConnexions et la façon de les utiliser dans vos propres applications.
présente des considérations générales sur la programmation des API HTML et énumère les spécifications, les valeurs et la signification de leurs paramètres.
décrit plusieurs principes pour la programmation des API XML et énumère les spécifications, les valeurs et la signification de leurs paramètres.
énonce les spécifications pour toutes les API du Portail de découverte de GéoConnexions.
présente des exemples de « pratiques exemplaires » pour ces concepts et technologies de programmation.
Les interfaces de programmation d'application de l'Infrastructure canadienne de données géospatiales vous permettent de programmer une interface aux services du Portail de découverte de GéoConnexions, de façon à pouvoir intégrer ces services dans votre application. La présente annexe:
décrit la conception et la structure des API du Portail de découverte de GéoConnexions; et
explique les différentes manières d'utiliser les API du Portail de découverte de GéoConnexions afin d'offrir des services à valeur ajoutée à vos utilisateurs.
Une interface de programmation d'application (API) est une interface entre un système d'exploitation et des programmes d'application. Cette interface couvre la communication entre des programmes d'application et un système d'exploitation, ainsi que les services que le système d'exploitation met à la disposition des programmes. Le Portail de découverte de GéoConnexions offre deux API :
Une API HTML : Le résultat de l'appel de services se présente sous forme de page Web en HTML;
Une API XML : Le résultat de l'appel de services se présente sous forme de document en XML.
Les services basés sur le langage XML constituent le fer de lance du Portail de découverte de GéoConnexions. Ces services comportent des interfaces qui entraînent l'interface homme-machine (IHM) dans des services aux utilisateurs, mais ils peuvent également être appelés directement par des applications externes. Si vous ne souhaitez pas utiliser le XML dans le contexte de votre application, vous pouvez diriger vos utilisateurs vers l'interface HTML et faire en sorte que le Portail de découverte de GéoConnexions retourne directement des résultats à l'utilisateur sous forme de page HTML.
Pour les deux interfaces, les mêmes services d'application sont utilisés : l'application qui effectue le traitement produit également les résultats. En d'autres mots, l'interface HTML du Portail de découverte de GéoConnexions utilise les mêmes services XML fournis aux applications externes. Les deux interfaces diffèrent par les spécifications d'interface (les services aux utilisateurs intègrent des commandes de présentation dans les spécifications d'interface) et le format de sortie (XML ou HTML).
Figure 34 Architecture des interfaces du Portail de découverte de GéoConnexions
Lorsque vous utilisez une API du Portail de découverte de GéoConnexions dans votre application, vos utilisateurs ont plusieurs possibilités :
Il y a deux façons d'utiliser les API du Portail de découverte de GéoConnexions afin d'offrir des services à valeur ajoutée à vos utilisateurs.
Le programme GOFC (Global Observation of Forest Cover), par exemple, utilise une API du Portail de découverte de GéoConnexions afin d'offrir une valeur ajoutée à ses utilisateurs. L'API donne accès à de nombreuses sources de données connexes que le programme GOFC n'a pas à gérer lui-même. La recherche sous forme de script, offerte comme un simple lien dans la page de gauche, fait un appel CGI (interface de passerelle commune) au Portail de découverte de GéoConnexions, puis le Portail de découverte de GéoConnexions retourne une page Web (à droite) contenant les résultats de l'appel CGI. Quand de nouvelles sources de données deviennent disponibles, elles sont ajoutées aux résultats de la recherche fournis par l'API du Portail de découverte de GéoConnexions.
Figure 35 Utilisation d'une API du Portail de découverte de GéoConnexions
Le moyen le plus facile d'utiliser une API du Portail de découverte de GéoConnexions consiste à créer un hyperlien direct dans vos pages Web afin de rediriger vos utilisateurs vers un service de l'ICDG. Pour ce faire, l'hyperlien doit être un appel API.
Pour créer l'hyperlien, suivez les 4 étapes suivantes :
La figure 36, Utilisation de l'API à l'aide d'un hyperlien direct, illustre le fonctionnement de cette méthode :
Figure 36 Utilisation de l'API à l'aide d'un hyperlien direct
La deuxième méthode d'utilisation de l'API consiste à transmettre des requêtes par l'intermédiaire de votre propre interface CGI (interface de passerelle commune) au moyen d'un lien intégré. Dans ce cas, les résultats sont retournés en XML et peuvent être interprétés et présentés dans votre propre application.
La figure 37, Utilisation de l'API à l'aide de votre interface CGI, illustre le fonctionnement de cette méthode :
Figure 37 Utilisation de l'API à l'aide de votre interface CGI