Les services disponibles

Description générale

Gosu est conçu selon l'architecture REST, basée sur l'architecture du Web et de ses standards de base : HTTP et URI).

Les appels aux différents services proposés peuvent se faire via les opérations GET et POST. Les formats d'échanges XML et JSON sont supportés aussi bien pour les requêtes aux services que pour les réponses renvoyées.

Qu'est ce qu'un web service?

Gosu propose des web services permettant d'interroger nos systèmes pour récupérer vos statistiques. Ces services utilisent des requêtes HTTP vers des URL bien spécifiques auxquelles sont ajoutés les paramètres à communiquer au service.

Une requête vers Gosu est en général de la forme suivante :

https://ws.estat.com/gosu/rest/service/format?parameters
où service correspond au service spécfiquement interrogé et format indique le format de réponse désiré (json ou xml).

Dans le cas d'une requête effectuée via la méthode POST (certaines fonctionnalitées ne sont disponibles qu'en utilisant la méthode POST), une requête s'effectue vers une URL du type :

https://ws.estat.com/gosu/rest/service/format

à laquelle est ajouté le contenu de la requête au format XML ou JSON.

Les Content-Type acceptés en POST sont :

Vous trouverez des exemples de requête pour chaque service et chaque méthode dans les sections de la documentation dédiées à chacun des services.

WADL et Schémas

La description WADL (Web Application Description Language) de Gosu peut être récupérée à l'adresse suivante :

https://ws.estat.com/gosu/rest/application.wadl

Gosu utilise Jersey, l'implémentation de référence JAX-RS pour la conception de web services REST dans un écosystème Java ainsi que JAXB pour l'utilisation de schémas XSD permettant de générer les formats d'échange des différents services.

Pour chaque service vous trouverez le schéma utilisé pour les requêtes ainsi que celui utilisé pour les réponses.

Nous vous recommendons d'utiliser un outil de génération automatique de classes à partir des schémas lorsque la technologie que vous utilisez le permet.

Encodage des données

Toutes les requêtes et les réponses sont traitées au format UTF8

Le contenu des requêtes effectuées sur Gosu doit être url encodé. De même, toutes les réponses renvoyées par le web service sont url encodées.

Le contenu suivant :

Un exemple de contenu à "encoder"

Doit être encodé sous la forme :

Un+exemple+de+contenu+%C3%A0+%22encoder%22