API Reference


L'API Reference a 2 objectifs :
Présenter l'intégralité de nos APIs, les requêtes possibles (GET, POST, PATCH, etc.) et détailler les champs disponibles.
Permettre de réaliser des tests rapidement avec une interface web.

Pour y accéder :
  •  https://apisandbox.hubintent.com/documentation/  (sandbox)
  •  https://api.hubintent.com/documentation/  (production)


Organisation

Toutes les pages sont organisées de la même manière.
Dans un 1er temps, vous sélectionnez l'API qui vous intéresse via le menu déroulant "Select a spec". Prenons Data v1.0
Nous retrouvons toutes les requêtes possibles sur l'API Data v1.0. Pour avoir le détail d'une requête, il vous suffit de cliquer dessus.
Vous trouvez dans un 1er temps des informations spécifiques à la requête puis vous arrivez sur le body de la requête, en cas de requête POST ou PATCH, ou sur les paramètres à indiquer, pour les requêtes GET.
Pour une requête POST ou PATCH, un exemple de body vous est proposé. Vous pouvez accéder au détail de chacun des champs en cliquant sur "Model"
L'astérisque rouge vous indique si le champ est obligatoire ou non. La nature de chaque champ est indiquée ainsi qu'un rapide descriptif. Pour plus de détail sur chaque champ, vous pouvez vous référer à la documentation accessible en haut à droite de l'écran ou via
Plus bas vous retrouvez les codes et messages de retours suite à une requête API avec le même principe d'avoir un exemple type (Exemple model) et le détail des champs (Model)

Réaliser vos premiers pas avec l'API Reference

Pré-requis

Pour réaliser une requête via les APIs d'intentPlatform, il vous faut un compte développeur avec un CLIENT_IDet un CLIENT_SECRET

Créer un flux de données

Sélectionnez l'API que vous souhaitez utiliser. Ici nous prenons l'API Data v1.0
Ensuite, identifiez-vous via le bouton "Authorize" et renseignez votre client_idet client_secret
Vous êtes maintenant authentifié pour réaliser des requêtes sur l'API Data v1.0
Nous allons créer un stream en réalisant un POST.
Je déroule la requête POST en cliquant dessus, puis je cliques sur "Try it out"
Le body de la requête est maintenant modifiable. Je renseigne les informations qui m'intéressent pour la création de mon flux de données. Puis, j'appuie sur "Execute" pour envoyer la requête.
En dessous, je découvre :
  • la requête en Curl
  • l'URL de la requête
  • le code de retour, ici 201
  • le body de la réponse

Récupérer un flux de données

Nous allons maintenant récupérer les caractéristiques du flux de données que nous venons de créer. Nous réalisons un GET by reference. Même fonctionnement, je déroule la requête GET, je clique sur "Try it out", j'indique la référence de mon stream en paramètre, ici "STREAM-testSandbox" puis j' "Execute".
Je trouve les messages de retour plus bas.