---
title: "Démarrer"
description: "Guide de démarrage pour utiliser les APIs"
url: "https://api-portal-suitelogi-ppr.stef.com/getting-started"
image: "https://api-portal-suitelogi-ppr.stef.com/_og/d/c_Ocean.takumi,title_~RMOpbWFycmVy,description_~R3VpZGUgZGUgZMOpbWFycmFnZSBwb3VyIHV0aWxpc2VyIGxlcyBBUElz,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiM1NTk2ZTYifX19,p_Ii9nZXR0aW5nLXN0YXJ0ZWQi,s_ooSvZ1Oz8_JBHtoB.png"
---

**Developer Portal**

-   [APIs](https://api-portal-suitelogi-ppr.stef.com/apis)
-   [Démarrer](https://api-portal-suitelogi-ppr.stef.com/getting-started)
-   [Guides](https://api-portal-suitelogi-ppr.stef.com/guides)
-   [Support](https://api-portal-suitelogi-ppr.stef.com/support)

**[FR](https://api-portal-suitelogi-ppr.stef.com/)**|[EN](https://api-portal-suitelogi-ppr.stef.com/en)|[ES](https://api-portal-suitelogi-ppr.stef.com/es)|[IT](https://api-portal-suitelogi-ppr.stef.com/it)|[PT](https://api-portal-suitelogi-ppr.stef.com/pt)|[NL](https://api-portal-suitelogi-ppr.stef.com/nl)|[DE](https://api-portal-suitelogi-ppr.stef.com/de)

## Démarrer avec les APIs

Suivez ce guide pour vous connecter au portail, créer votre application, vous abonner aux APIs et effectuer votre premier appel.

## [1\. Se connecter au Portail API](#_1-se-connecter-au-portail-api)

Les portails API STEF vous permettent de vous abonner aux APIs STEF par le biais d'applications consommatrices personnelles, ou partagées au sein d'une équipe.

En tant qu'employé STEF, il n'est pas nécessaire de demander la création d'un compte pour accéder aux portails.

Rendez-vous sur le portail souhaité puis, au moment de l'authentification, cliquez sur le bouton **Se connecter en tant que salarié STEF**.

Consultez le guide des instances APIM pour obtenir la liste des portails disponibles et leurs usages.

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 en créant un ticket JIRA APIM, en précisant le nom de l'équipe et le(s) portail(s) cible(s).

## [2\. Créer une application](#_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.

1.  Cliquez sur votre profil en haut à droite du portail
2.  Cliquez sur le bouton **[Applications](https://api-portal-suitelogi-ppr.stef.com/apps)**
3.  Cliquez sur le bouton **New application**
4.  Renseignez le nom et la description de votre application
5.  Pour partager cette application avec votre équipe, cochez **This is a team owned application** et sélectionnez l'équipe souhaitée
6.  Cliquez sur le bouton **Create application**
7.  Notez le credential généré lors de la création

Ce credential n'apparaît qu'à la création de votre application et ne sera plus visible ensuite. Conservez-le précieusement.

## [3\. S'abonner à une API](#_3-sabonner-à-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 :

1.  Affichez le détail d'une API
2.  Cliquez sur **Use this API** en haut à droite
3.  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](#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](#_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.stef.com](https://api-suitelogi.stef.com)
-   Qualification : [https://api-suitelogi-qua.stef.com/](https://api-suitelogi-qua.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](#exemple-dinvocation)

```bash
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!**.

## [Prochaines étapes](#prochaines-étapes)

## Catalogue des APIs

[Voir les APIs →](https://api-portal-suitelogi-ppr.stef.com/apis)

## Guides techniques

[Voir les guides →](https://api-portal-suitelogi-ppr.stef.com/guides)

## Instances APIM

[Voir les instances →](https://api-portal-suitelogi-ppr.stef.com/getting-started/instances)

#### [APIs](#apis)

-   [Catalogue des APIs](https://api-portal-suitelogi-ppr.stef.com/apis)
-   [Guide de démarrage](https://api-portal-suitelogi-ppr.stef.com/getting-started)

#### [Développeurs](#développeurs)

-   [Documentation](https://api-portal-suitelogi-ppr.stef.com/guides)
-   [Bonnes pratiques](https://api-portal-suitelogi-ppr.stef.com/guides/best-practices)
-   [Portails](https://api-portal-suitelogi-ppr.stef.com/getting-started/instances)

#### [Support](#support)

-   [Support technique](https://api-portal-suitelogi-ppr.stef.com/support)

#### [Langues](#langues)

-   [Français](https://api-portal-suitelogi-ppr.stef.com/)
-   [English](https://api-portal-suitelogi-ppr.stef.com/en)
-   [Español](https://api-portal-suitelogi-ppr.stef.com/es)
-   [Italiano](https://api-portal-suitelogi-ppr.stef.com/it)
-   [Português](https://api-portal-suitelogi-ppr.stef.com/pt)
-   [Nederlands](https://api-portal-suitelogi-ppr.stef.com/nl)
-   [Deutsch](https://api-portal-suitelogi-ppr.stef.com/de)

© 2026 STEF — Tous droits réservés

[Mentions légales](https://www.stef.com/mentions-legales) · [Politique de confidentialité](https://www.stef.com/politique-confidentialite)