FAQ - SoGet API

Qu'est-ce qu'une API ?

Une API (Application Programming Interface ou interface de programmation des applications) est une interface logicielle qui permet de connecter un logiciel à un autre logiciel ou service afin d’échanger des données et des fonctionnalités.

Les API offrent une nouvelle façon de communiquer avec d’autres produits et services sans connaître les détails de leurs mises en œuvre. Elles simplifient considérablement la façon de développer et intégrer de nouveaux composants et fonctionnalités dans une architecture logicielle existante.

Quelles sont les avantages des API ?

Les API apportent une réelle valeur ajoutée à vos projets d’industrialisation de données pour développer vos propres outils ou enrichir vos applications d’aide à la décision.

Qu'est-ce que le portail SoGet API ?

Le portail SoGet API est un portail public accessible en ligne. Il est le premier point d’accès pour la découverte des API SOGET et permet d’interagir avec la documentation commerciale et technique, de fournir des commentaires, d’obtenir des informations, d’abonnement et de paiement, etc. C’est la brochure numérique interactive et une fenêtre sur les offres API de SOGET.

Dans le portail SoGet API vous trouverez, pour chacune des API SOGET, les informations suivantes :

une présentation de l’API ;
un accès au portail développeur qui est un portail accessible en ligne pour nos utilisateurs authentifiés et autorisés. Il contient la documentation technique des services exposés par l’API ;
un portail de facturation qui gère le paiement et la facturation des API ;
la liste des mises à jour effectués depuis sa publication ;
etc.

Quels sont les étapes pour utiliser une API ?

SoGet API vous permet d’utiliser les APIs exposées selon le mode de souscription que vous allez choisir. Pour cela vous devez réaliser les étapes suivantes :

Créer une société. Vous pouvez ensuite ajouter des membres susceptibles d’accéder à cette société selon les droits que vous leur accordez.
Créer une application. Vous pouvez ainsi obtenir vos premiers identifiants d’accès qui prennent la forme d’un couple identifiant / clé secrète. Ces premiers identifiants d’accès vous permettent de générer un « access token » (un jeton individuel d’accès qui permet d’authentifier l’appel à l’API).
Souscrire à une API. Vous pouvez ensuite générer une clé API pour cette API.
Générer une clé API. Vous pouvez ainsi obtenir à votre deuxième identifiant d’accès à l’API à laquelle vous venez de souscrire.

Concrètement, les étapes 2 et 3 sont les étapes de l’authentification de l’utilisateur. Nous utilisons le principe d’une double authentification pour générer vos identifiants d’accès qui prennent la forme suivante :

Etape 2 : Authentification de l’application (via le protocole OAuth2).
Etape 3 : Authentification de l’entité à facturer (Via une clé API)

Quels sont les différents rôles disponibles pour les utilisateurs de SoGet API ?

Droit « Lecteur » : accède uniquement en lecture aux informations du portail et peut donc :

Accéder à la documentation
Accéder en lecture aux informations sociétés
Accéder en lecture à la liste des API exposées
Accéder en lecture à la liste des offres commerciales / abonnements
Changer son mot de passe

Droit « Editeur » : possède les droits d’un utilisateur « Lecteur » et peut de plus :

Gérer les applications
Gérer les clés API

Droit « Propriétaire » : possède les droits d’un utilisateur « Editeur » et peut de plus :

Effectuer les transactions
Gérer les offres commerciales (souscrire, modifier, supprimer)
Consulter les factures

Comment souscrire à une API ?

1. Sélectionnez l’API et l’offre à laquelle vous souhaitez souscrire. Les différentes offres sont affichées dans la page de présentation de l’API.

2. Cliquez sur le bouton « souscrire », vous serez ensuite automatiquement redirigé vers le formulaire de souscription.

3. Soumettez le formulaire.

4. Vous serez ensuite redirigé vers le portail de facturation. Vous devez remplir le formulaire et le soumettre.

5. Une fois la souscription validée, vous pouvez commencer à utiliser l’API !

Peut-on tester une API ?

Oui ! vous pouvez tester une API si la formule « découverte » est disponible ou une offre avec un nombre d’appel limité à 0 €.

Quels sont les prérequis pour réaliser des tests d’API ?

Des connaissances techniques sont requises pour pouvoir tester l’API avec un outil tel que Postman ou Insomnia ou pour pouvoir intégrer l’API dans vos applications interne.

Quelles sont les données retournées par une API ?

Chaque API renvoi des données qui lui sont spécifique. Lorsque vous accéder au portail développeur d’une API vous aurez les détails des données retournées.

Est-ce que je serai facturé pour une réponse vide ?

Non, vous serez uniquement facturé lorsque l’API retourne un résultat.

J’utilise déjà des EDI, quelles sont les différences avec les API ?

Les API sont des interfaces de programmation, accessibles depuis le net, qui permettent aux applications de communiquer entre elles. Ce mode d’échange est beaucoup plus souple, et plus évolutif que l’utilisation des EDI.

J’ai un problème, comment puis-je vous contacter ?

Il vous suffit de créer votre compte Espace Client SOGET, pour pouvoir soumettre vos demandes d’assistance, les suivre et les clôturer. Vous pouvez également demander à être rappelé par nos équipes avec la fonction « Call Back ».

Quels modes de paiement acceptez-vous ?

Nous acceptons les paiements par carte de crédit et de débit.

Est-ce que mes informations de paiement sont sécurisées ?

Oui, nous utilisons Stripe, un prestataire de services de paiement de confiance, pour traiter toutes les transactions. Stripe est certifié PCI DSS de niveau 1, le plus haut niveau de sécurité dans l'industrie des paiements.

Questions fréquentes

Gérer le consentement aux cookies