Avant de pouvoir utiliser l'API, il vous faudra créer une clé API sur le serveur CartoVista
CartoVista possède une API serveur qui permettra d'automatiser n'importe laquelle de vos actions sur le serveur, telles que le chargement d'un jeu de données, la modification d'un jeu de données ou d'une partie d'un jeu de données, la suppression d'un objet sur le serveur, etc.
L'API de CartoVista est basée sur les principes REST. Les appels à l'API se font par des requêtes HTTP, en utilisant les méthodes standard suivantes : GET, POST, DELETE, PATCH.
Voici les étapes à suivre pour créer votre clé API.
- Allez sur la page des Utilisateurs dans le serveur de CartoVista :
- Sélectionnez votre utilisateur dans la liste. Cela ouvre le panneau d'information sur la droite. Allez dans Clé API et sélectionnez Ajouter une nouvelle clé :
- Saisissez votre adresse IP externe dans la fenêtre de dialogue et cliquez sur Ajouter la clé API :
- Votre clé API est maintenant disponible dans votre profil utilisateur :
Copiez et collez-la dans le header apiKey de vos requêtes pour autoriser vos requêtes. Le paramètre apiKey peut également être passé dans l'url de la requête directement (query string parameter).
ℹ️ Les clés API sont liées à des adresses IP externes. Vous devrez donc effectuer les appels API à partir de l'ordinateur dont l'IP a été enregistrée. Il est possible d'enregistrer plusieurs adresses IP externes pour une seule clé API. Il suffit de lister les IP en les séparant par un point-virgule :
Si vous voulez éviter d'utiliser la liste blanche d'adresses IP, vous pouvez créer une clé secrète. La clé secrète n'est visible que temporairement sur le serveur, et vous devrez la régénérer si vous ne la sauvegardez pas ailleurs. Ajoutez un en-tête secretKey à vos requêtes pour l'utiliser.
Cliquez sur le bouton Générer une clé secrète pour générer une clé secrète :
Votre clé secrète temporaire sera alors visible juste en dessous de votre clé d'accès permanente :
Elle disparaîtra dès que vous aurez quitté le panneau d'information.