HomeBlogComment tester l'API Openapi sans être développeur (Guide pour les débutants)
Principes base API

Comment tester l'API Openapi sans être développeur (Guide pour les débutants)

Vous voulez savoir comment fonctionne notre API? Quelles sont les données disponibles pour une entreprise ou un bien immobilier et vous ne voulez pas avoir besoin de l'aide d'un développeur? Suivez notre guide

Guide API

Vous souhaitez savoir comment fonctionnent nos API, quelles données sont disponibles pour une entreprise ou un bien immobilier et vous ne voulez pas demander l'aide d'un développeur ? Pas de problème, suivez notre guide et vous pourrez tester notre API en quelques secondes. Même si vous ne connaissez rien au code !

La fonctionnalité qui vous aidera est "Try It Out" et est disponible dans la zone Console, dans tous les endpoints.

Enregistrez-vous d'abord!

Pour utiliser notre API, si vous ne l'avez pas encore fait, vous devez d'abord vous enregistrer.

Une fois l'inscription terminée, connectez-vous et, si vous n'y êtes pas déjà, accédez au portail Console, où vous trouverez la documentation technique pour l'intégration de notre API et la fonctionnalité Try It Out pour tester l'API.

Register

 

Choisir, activer l'API et créer un token

Pour commencer, les principales étapes sont les suivantes:

1) Choisissez l'API qui vous intéresse dans la section Bibliothèque (pour accélérer votre recherche, vous pouvez filtrer les API par catégorie).

2) Activez l'API en cliquant sur le bouton Activer et suivez les instructions.

Pour certains services, il peut vous être demandé de procéder à une authentification à deux facteurs ou de saisir un identifiant (une fois la première API activée, pour la plupart des autres, il vous suffit de cliquer sur "Activer" pour les rendre opérationnelles).

3) Créez le token pour vous authentifier

Si l'API que vous recherchez ne prévoit pas des requêtes gratuits, rechargez votre crédit avant de continuer.

Si, en revanche, vous avez vérifié que l'API qui vous intéresse inclut des requêtes gratuits, vous pouvez passer directement à la création de votre premier jeton, une forme de mot de passe dont vous aurez besoin pour vous authentifier et utiliser l'API en toute sécurité.

Pour créer votre premier token, vous pouvez utiliser

Token

 

  • l'endpoint Post / Token de l'API Oauth. Dans ce cas, vous devrez utiliser l'APIKey Sandbox disponible dans la section Authentification

Authentification

 

Copiez le token, une série de caractères alphanumériques, que vous avez généré car vous devrez bientôt l'utiliser.

Vous êtes prêt pour votre premier requête

Nous utiliserons l'API Company comme exemple de notre premier requête, en particulier l'endpoint GET /IT-advanced/{vatCode_taxCode_or_id} qui est l'un des plus utilisés et qui est "synchrone", c'est-à-dire qu'il offre des résultats en temps réel.

Company Advanced VAT number permet, à partir d'un paramètre (par exemple le numéro de TVA), d'obtenir une série d'informations sur l'entreprise, telles que l'adresse du siège social, l'email certifié, le chiffre d'affaires et les bénéfices des trois dernières années, ainsi que le nombre de salariés. D'autres endpoints peuvent demander les données cadastrales d'une propriété ou le code fiscal d'un particulier.

Vérifiez que le serveur est configuré sur Production (et non sur Sandbox) pour obtenir les données réelles et ne pas utiliser l'environnement de test.

Company Openapi

 

Il est maintenant temps d'utiliser le token que nous avons créé et de procéder à l'authentification. Cliquez sur le bouton Autorise et dans le champ Value, entrez le token, puis cliquez sur Close.

Token

 

Une fois la procédure d'authentification terminée, cliquez sur l'endpoint souhaité (GET /IT-advanced/{vatCode_taxCode_or_id}) et la section d'authentification s'ouvrira.

Sur le côté droit, le bouton Try it Out (Essayer) devient visible; il s'agit de la fonctionnalité permettant d'essayer l'requête.

Les paramètres de recherche pour Get Company Advanced sont le numéro de TVA, le code fiscal ou l'identifiant. Nous utiliserons le numéro de TVA, c'est-à-dire le numéro de TVA de l'entreprise qui fait l'objet de l'audit.

Saisissez ensuite le numéro de TVA et cliquez sur le bouton Execute.

Execute

 

Votre requête a été envoyé et, si vous faites défiler l'écran jusqu'à Responses > Response Body, vous trouverez la réponse à votre requête avec toutes les données disponibles sur l'entreprise. Les données sont structurées en Json, un format d'échange de données simple et facilement lisible.

Ces données sont-elles celles dont vous aviez besoin? Contactez votre développeur pour lancer la procédure d'intégration.

Vous avez des doutes sur les données ou vous avez besoin d'autres informations et vous ne les trouvez pas sur le site? N'hésitez pas à nous contacter pour savoir comment notre API peut aider votre entreprise.

Comment tester l'API Openapi sans être développeur (Guide pour les débutants)
Partager sur