Parcourez et tester les requêtes API

Une fois votre clé API créée, vous pouvez utiliser la documentation swagger pour parcourir les requêtes et les essayer.


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.


 

CartoVista utilise swagger pour documenter l'API du serveur. Vous trouverez l'interface swagger à l'URL suivante :

https://your-portal-url.com/your-subscription/WebPortalServices/swagger/ui/index#/ .

Swagger est utile pour en savoir plus sur l'API du serveur, découvrir tous les appels et méthodes disponibles, et les essayer en utilisant votre clé d'API. Cependant, il ne peut pas être utilisé pour automatiser vos tâches.

Swagger vous donne la liste de tous les entrées de l'API, organisés par thème.

Vous pouvez entrer votre clé API pour tester une requête. Cliquez sur une entrée pour voir les détails.swagger

Remplissez les paramètres, puis cliquez sur Try it out! :

swagger_request_example

La réponse contiendra la requête Curl, le corps de la réponse et le code de la réponse.swagger_response_example

✔️  Vous pouvez maintenant utiliser n'importe quel logiciel capable d'envoyer et de recevoir des requêtes HTTP pour utiliser l'API du serveur CartoVista et commencer à automatiser vos tâches serveur.