Passer au contenu principal

Comment utiliser l'API Ezus ?

Le guide ultime pour réaliser votre première requête authentifiée.

Écrit par Ezus team

1. Premiers pas

L'API Ezus vous permet de lire et d'écrire vos données Ezus (projets, clients, fournisseurs, produits, étapes…) à partir de vos propres outils.

Pour commencer à utiliser l'API EZUS, vous aurez besoin de :

  • Un compte EZUS Premium actif

  • Une clé API

  • Un Bearer Token

Notre documentation technique fournit des informations détaillées sur tous les points de terminaison disponibles, les paramètres et les exemples de requêtes. ​

👾 Documentation API EZUS : https://api.ezus.io/

💡 L'API est disponible exclusivement pour nos clients ayant souscrits à un abonnement Premium ou Entreprise.

2. Obtenir votre clé API

La plupart des routes nécessitent une clé API pour l'authentification. Vous pouvez trouver votre clé API directement depuis votre espace de travail Ezus. ​

Pour cela, rendez-vous dans Paramètres > Développeurs depuis https://pro.ezus.io/settings .

🚨 Une clé API est privée et doit rester confidentielle. Faites attention à qui a accès et où elle est stockée.

3. Comprendre les endpoints et les méthodes

Étudiez les endpoints (URLs) avec lesquels vous pouvez interagir et la méthode HTTP nécessaire pour chacun :

GET — récupérer des informations

POST — ajouter ou modifier des informations

PUT / PATCH — modifier les données existantes

Webhooks — déclencher une action sur un événement spécifique​

4. Authentification

L'API EZUS utilise un processus d'authentification sécurisé en deux étapes.

1. Clé API

Incluez votre clé API dans l'en-tête de chaque requête : ​

x-api-key: YOUR_API_KEY

Cela permet d'identifier votre intégration. Elle est statique, créée une fois dans vos paramètres et envoyée avec chaque requête.

2. Bearer Token

Authentifiez votre utilisateur en appelant le endpoint /login. ​

Vous recevrez un Bearer Token valide pendant 12 heures, qui doit être inclus dans les requêtes nécessitant une authentification : ​

Authorization: Bearer YOUR_TOKEN

Lorsque votre token expire, il suffit d'en demander un nouveau en appelant le point de terminaison /login à nouveau. ​ ​

ℹ️ Qu'est-ce qu'un Bearer Token ?

Un Bearer Token est un jeton de sécurité temporaire qui prouve votre identité à l'API EZUS.

Après vous être connecté via le endpoint /login en utilisant vos identifiants EZUS, l'API renvoie un Bearer Token. Ce token doit ensuite être inclus dans l'en-tête Authorization de vos requêtes : ​

Authorization: Bearer YOUR_TOKEN

Le serveur vérifie que le token est valide avant d'accorder l'accès à vos données.

Pourquoi utiliser un Bearer Token ? Cette méthode d'authentification offre plusieurs avantages :

  • Sécurité renforcée : votre mot de passe n'est jamais envoyé avec chaque requête.

  • Durée de vie limitée : le token expire automatiquement après 12 heures, réduisant les risques de sécurité en cas de compromission.

  • Meilleures performances : une fois authentifié, vous pouvez effectuer plusieurs requêtes API sans vous reconnecter.

Lorsque votre Bearer Token expire, il suffit d'appeler le endpoint /login pour en obtenir un nouveau. ​

Pensez cela comme un bâtiment : la x-api-key est votre badge pour entrer dans le bâtiment, et le Bearer Token est la clé des salles à l'intérieur. Vous avez besoin des deux.

Le flux complet ressemble à ceci :

Paramètres → API → copier votre x-api-key 
POST /login (+ x-api-key) → recevoir un Bearer Token (valide 12h) Toute requête (+ les deux) → accéder à vos données
Token expiré ? → appeler /login à nouveau pour en obtenir un nouveau

Vous pouvez envoyer vos requêtes en utilisant un outil comme Postman ou un langage de programmation comme Python. Incluez votre clé API dans les en-têtes de la requête comme l'exige la documentation. ​

Pour en savoir plus sur Postman, consultez notre article ✍️ Utiliser Postman pour vos appels sur l'API Ezus (à venir) ​

Se connecter pour obtenir un Bearer Token Appelez le point de terminaison /login avec votre clé API et vos identifiants Ezus. Vous recevrez un Bearer Token valide pendant 12 heures.

curl -X POST https://api.ezus.io/login \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "[email protected]","password": "YOUR_EZUS_PASSWORD"}'

Exemple de réponse :

{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6..." } 

Copiez le token renvoyé puis transmettez le comme votre Bearer Token à l'étape suivante.

5. Générer les réponses

Chaque requête qui accède à vos données doit inclure les deux en-têtes : votre clé API et votre Bearer Token.

curl -X GET https://api.ezus.io/projects \
-H "x-api-key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_TOKEN"

Choisissez la méthode correspondante à ce vous souhaitez faire : ​

GET — Récupérer des informations (p. ex. lister vos projets)

POST — Créer de nouvelles données (p. ex. un nouveau projet ou fournisseur)

PUT / PATCH — Modifier les données existantes

Webhooks — Déclencher une action sur un événement spécifique (p. ex. un projet est créé) ​

L'URL exacte pour chaque action (sa « route »), les paramètres qu'elle accepte et les données qu'elle renvoie sont tous listés dans la documentation API : https://api.ezus.io/

Les réponses sont renvoyées en JSON. Analysez la réponse et extrayez les champs dont votre application a besoin. ​ Une réponse de liste typique ressemble à ceci :

{
"data": [ { "reference": "PRJ-001", "title": "Peru Discovery", "budget": 4200 }, { "reference": "PRJ-002", "title": "Iceland Roadtrip", "budget": 3100 } ]
}

💡 Vérifiez toujours le code de statut HTTP avant d'analyser : 2xx signifie succès, 4xx signifie qu'il y a un problème avec votre requête.


Erreurs fréquentes

  • Erreurs d'authentification

Si vous recevez une erreur 401 Unauthorized ou 403 Forbidden, vérifiez que :

  • votre clé API (x-api-key) est valide ;

  • votre Bearer Token n'a pas expiré (valide pendant 12 heures) ;

  • les deux en-têtes d'authentification sont inclus lorsque cela est nécessaire.

Si nécessaire, générez un nouveau token via le endpoint /login. ​

  • Limitation de débit

Pour assurer la stabilité de la plateforme, l'API EZUS applique une limitation de débit.

Si vous recevez une erreur 429 Too Many Requests, réduisez la fréquence de vos requêtes ou implémentez une nouvelle tentative avec recul exponentiel avant de réessayer. ​

Avez-vous trouvé la réponse à votre question ?