Introduction
Apprenez à intégrer nos API dans vos applications
Vous devez créer un compte gratuit Lygos pour commencer à utiliser nos servces API.
Nos API
Nos API reposent sur les principes REST, une architecture qui garantit des services fiables, flexibles et faciles à intégrer. Elles utilisent les méthodes HTTP classiques comme GET, POST, PUT et DELETE pour interagir avec les ressources. Les réponses sont toujours au format JSON, ce qui les rend simples à comprendre et à utiliser avec les outils de développement modernes. Que vous construisiez une application, connectiez des systèmes ou enrichissiez votre plateforme, nos API sont là pour vous offrir une expérience fluide et agréable.
En apprendre davantage sur REST
View the OpenAPI specification file
Réponses et Erreurs
Voici la liste des erreurs et des réponses associées que vous pourrez rencontrer durant la mise en place des API dans votre application. Lygos maintient un formattage clair et comprehensible pour vous faciliter l’intégration.
| Code Statut | Catégorie | Description | Exemple |
|---|---|---|---|
| 200 | Succès | La requête a réussi, et le serveur a renvoyé les données attendues. | GET /users renvoie une liste d’utilisateurs. |
| 201 | Créé | La ressource a été créée avec succès. | POST /users renvoie les détails du nouvel utilisateur. |
| 204 | Aucun Contenu | La requête a réussi, mais aucune donnée n’est retournée. | DELETE /users/{id} après suppression réussie d’un utilisateur. |
| 400 | Requête Incorrecte | Le serveur n’a pas compris la requête en raison d’une syntaxe invalide. | Champs obligatoires manquants dans une requête POST. |
| 401 | Non Autorisé | Une authentification est requise ou a échoué. | Jeton API manquant ou invalide. |
| 403 | Interdit | Le client n’a pas les permissions nécessaires pour accéder à la ressource. | Tentative d’accès à des données restreintes. |
| 404 | Non Trouvé | La ressource demandée est introuvable. | GET /users/{id} pour un utilisateur inexistant. |
| 409 | Conflit | La requête entre en conflit avec l’état actuel du serveur. | Tentative de création d’une ressource en double. |
| 422 | Entité Non Traitée | La requête est bien formée mais contient des données invalides. | Données invalides pour la création d’une ressource. |
| 500 | Erreur Serveur Interne | Le serveur a rencontré une condition inattendue. | Erreurs générales ou exceptions inattendues du serveur. |
| 502 | Mauvaise Passerelle | Le serveur a reçu une réponse invalide d’un serveur en amont. | Problème temporaire avec les services en amont. |
| 503 | Service Indisponible | Le serveur est temporairement incapable de traiter la requête (surcharge ou maintenance). | Panne planifiée ou surcharge du serveur. |
| 504 | Délai d’Attente | Le serveur n’a pas reçu de réponse à temps d’un serveur en amont. | Requêtes longues causant des délais d’attente. |
Authentification
Tous nos endpoints nécessitent une authentification pour garantir la sécurité et l’intégrité des données. Chaque requête doit inclure une API key valide, transmise dans l’en-tête HTTP api-key comme suit :