👨‍💻 Introduction à l'API Ugosign

🎯 Objectif

Comprendre les fondamentaux de l’API REST Ugosign et réaliser votre premier appel authentifié afin d’intégrer la signature électronique dans vos applications web ou mobiles.

📝 Prérequis

• Un compte Ugosign actif avec droits suffisants.
• Une clé d’API (voir "🔑 Générer une clé d'API sur Ugosign").
• Connaissances de base en HTTP/REST et gestion des Authorization: Bearer <token>.
• Accès réseau HTTPS.

📍 Étapes

1. Créer et sécuriser votre clé d’API
   Accédez à votre tableau de bord Ugosign et générez une clé. Stockez-la de manière sécurisée (coffre-fort de secrets, variables d’environnement, jamais en clair dans le code).
2. Choisir l’environnement et la base d’URL
   Utilisez les URL fournies dans la documentation et notez la version de l’API.
3. Configurer l’authentification
   Ajoutez l’en-tête HTTP suivant à chaque requête : Authorization: Bearer <votre_clé_api>. Assurez-vous d’envoyer et recevoir du application/json.

   GET /... HTTP/1.1 Host: <base-url> Authorization: Bearer <votre_clé_api> Accept: application/json

4. Réaliser un premier appel de vérification
   Effectuez un appel simple (ex. GET /api/v1/organization) pour valider l’authentification et la connectivité.
5. Parcourir la documentation interactive
   Explorez les endpoints disponibles, les schémas de requête/réponse et les codes d’erreur.

   Documentation API Ugosign

✅ Résultat attendu

• Une clé d’API active et stockée de manière sécurisée.
• Un premier appel HTTPS authentifié retournant 200 OK.
• Une vision claire des endpoints pertinents pour votre cas d’usage.

💡 Bon à savoir

• Conformité & sécurité : l’API suit les bonnes pratiques de chiffrement et de protection des données.
• Gestion des erreurs : référez-vous aux codes HTTP standard et aux messages d’erreur structurés.
• Bonnes pratiques : rotation périodique des clés, principe du moindre privilège, journaux sécurisés.

🔗 Ressources associées

• Documentation API Ugosign
• 🔑 Générer une clé d'API sur Ugosign