Démarrer avec les APIs STEF
Suivez ce guide pour activer votre compte, créer votre application, vous abonner aux APIs et les appeler en toute sécurité.
1. Se connecter au Portail API
Le portail API STEF vous permet de vous abonner aux APIs STEF par le biais d'applications consommatrices personnelles, ou partagées au sein d'une équipe.
- Afin d'accéder au portail, il est nécessaire de faire une demande de création d'un compte client.
- Pour cela, prenez contact avec votre référent STEF IT afin qu'il s'occupe des démarches.
- Vous recevrez une invitation vous permettant de créer votre compte et de vous connecter aux portails de qualification et de production STEF.
Le mot de passe est à renouveler tous les 200 jours ; vous serez prévenu de ce besoin de mise à jour lors de la connexion au portail.
Accès aux portails API
- Production : https://api-portal-ext.stef.com/
- Qualification : https://api-portal-quaext.stef.com/
Afin de pouvoir créer une application consommatrice partagée avec votre équipe, il est nécessaire de demander la création d'une équipe auprès de votre référent STEF IT.
2. Créer une application
Pour pouvoir consommer une API, vous devez disposer au préalable d'une application consommatrice. Sa création génère un credential, l'identifiant de votre application lors d'un appel.
- Cliquez sur votre profil en haut à droite du portail
- Cliquez sur le bouton Applications
- Cliquez sur le bouton New application
- Renseignez le nom et la description de votre application
- Pour partager cette application avec votre équipe, cochez This is a team owned application et sélectionnez l'équipe souhaitée
- Cliquez sur le bouton Create application
- Notez le credential généré lors de la création
3. S'abonner à une API
Une application consommatrice peut s'abonner à une ou plusieurs APIs en fonction de ses besoins.
Utilisez le menu APIs pour consulter le catalogue des APIs STEF disponibles.
Naviguez vers les produits qui vous intéressent afin d'afficher la documentation technique développeur, qui présente pour chaque API :
- Les différentes opérations supportées
- La définition des objets d'entrée et de sortie
- Des exemples de code permettant de les consommer
Pour s'abonner à une API :
- Affichez le détail d'une API
- Cliquez sur Use this API en haut à droite
- Cliquez sur le bouton Register associé à l'application que vous souhaitez abonner
L'abonnement devra ensuite être validé par STEF ; rapprochez-vous de votre référent STEF IT pour cela.
Une application pouvant s'abonner à plusieurs APIs, répétez la procédure d'abonnement pour chacune des APIs que vous souhaitez utiliser.
Consulter et gérer vos abonnements
Pour consulter les abonnements d'une application, cliquez sur votre profil en haut à gauche puis sur Applications, puis sur le nom de votre application. Dans l'onglet APIs, affiché automatiquement, retrouvez la liste de vos abonnements ainsi que leur statut.
Vous pouvez également demander un abonnement à d'autres APIs directement depuis ce menu, en cliquant sur + API.
4. Consommer une API
Toutes les invocations d'API STEF passent par la Gateway API STEF afin d'appliquer les règles de sécurité d'accès, d'assurer la protection des services backend du système d'information STEF et de collecter les statistiques d'invocation.
Les Gateway API sont accessibles via les URL suivantes :
- Production : https://api-suitelogi-ext.stef.com
- Qualification : https://api-suitelogi-quaext.stef.com
Pour consommer une API et respecter les règles de sécurité d'accès, ajoutez le header HTTP X-STEF-Client-Id à la requête, valorisé avec le credential de votre application consommatrice.
La documentation technique développeur propose, pour chaque API publiée sur la plateforme, des exemples de code permettant d'invoquer la Gateway API depuis différents langages : Shell, Python, Node.js, JavaScript, Go, Java, C# et Ruby.
Exemple d'invocation
curl -X GET "https://api.stef.com/v1/transport/orders" \
-H "X-STEF-Client-Id: <YOUR_APPLICATION_SECRET>" \
-H "Content-Type: application/json"
En complément des exemples de code, la documentation technique développeur propose des formulaires permettant d'invoquer les APIs directement depuis le portail, en mode interactif, via le bouton Try it!.