Introduction à la documentation de l’API

Bienvenue dans la documentation de l’API Karanext.
Ce guide regroupe l’ensemble des informations nécessaires pour activer l’API, créer des applications, obtenir des jetons d’accès et intégrer des services externes de manière sécurisée et efficace.

Cette documentation est conçue pour aider les développeurs, intégrateurs et administrateurs techniques à :

• Comprendre le fonctionnement global de l’authentification ;
• Activer l'API dans l’application ADMIN ;
• Créer et configurer des applications avec des permissions spécifiques ;
• Demander des jetons d’accès sécurisés ;
• Réaliser des appels API.

🔐 Aperçu du modèle de sécurité

La plateforme utilise un modèle d’authentification basé sur des jetons.
Les applications doivent utiliser le point de terminaison POST

/token

en fournissant leurs identifiants afin d’obtenir un jeton.

Ce jeton :

• A une durée de vie de 5 minutes.
• Doit être inclus dans chaque requête API (Authorization: Bearer <token>).
• Est limité par les permissions définies lors de la création de l’application.

🧭 Vue d’ensemble du flux d’intégration

Voici le flux global d’utilisation de l’API :

1. Activer l’API dans l’application ADMIN
2. Créer une application API et configurer ses permissions
3. Récupérer les identifiants (client_id, application_id, secret)
4. Demander un jeton d’accès via le point de terminaison POST

   /token

5. Utiliser le jeton pour effectuer les requêtes API
6. Renouveler le jeton toutes les 5 minutes si nécessaire

🛠 Prérequis techniques

Pour utiliser l’API, il vous faut :

• Un compte Karanext.
• L’accès à l’application ADMIN avec la permission administrateur.
• Vos informations d'accès à l'API.