Site OpenData49 : vel concedere amicis, quidquid velint

5 Applications

82 Données

Appels à l'api

URL d'accès à l'API

Il est possible d'attaquer l'API dans sa version XML sur l'URL suivante : 

Cette URL accepte les requêtes via les méthodes POST ou GET.

URL d'accès à l'API en JSON

Il est également possible d'attaquer l'API dans sa version JSON sur l'URL suivante : 

Cette URL accepte les requêtes via les méthodes POST ou GET.

Les exemples de la documentation seront tous donnés en XML, mais sont tous valables pour JSON au format de sortie prêt

Paramètres d'appels obligatoires

ParamètresValeur
version0.
keyVotre clé d'API.
cmdLa commande à executer.

Voici un exemple d'appel de l'API à l'aide la méthode GET.

https://www.opendata49.fr/xml/?version=1.0&key=XXXXXXXXXXXXXXX&cmd=macommande

Format de réponse de l'API

L'API fournit des réponses au format XML La réponse contient systématiquement les éléments suivant : 

Tagsdescriptions

<request>

Un écho de la commande complète envoyé à l'API. Permet de vérifier que la commande reçue par l'API est bien celle envoyée.
<answer>Les données de réponse de l'API.
<status>Le statut de la réponse de l'API. La signification des codes est disponible ici.
<data>Les données proprement dites. Leurs formats est spécifique à chaque commande.

Voici un exemple de réponse de l'API.


<opendata>
    <request>https://www.opendata49.fr/xml/request>
    <answer>
        <status code="4" message="Please, provide an API key."/>

    answer>
opendata>

Code de statut de la commande

CodeSignificationDescription
0SuccessLa commande s'est déroulée avec succès
1Invalid keyLa clé est invalide
2Invalid versionLa version est invalide
3Invalid commandLa commande est invalide
4Empty keyLa clé est vide
5Empty versionLa version est vide
6Empty commandLa commande est vide

8

Usage limit reachedLe nombre de requêtes de la clé a été atteint
98DisabledL'API a été désactivée par un administrateur
99MaintenanceL'API est en cours de maintenance.
100+Command error code Le code d'erreur est spécifique à la commande