Introduction
Conventions, authentification et gestion des erreurs de l'API
Conventions
L'API d'Arrhes suit les conventions REST standard :
- ✓GET pour la lecture, POST pour la création, PATCH pour la modification, DELETE pour la suppression
- ✓Le corps de la requête et la réponse sont en JSON
- ✓Les dates suivent le format ISO 8601
- ✓Les montants (débit, crédit) sont des chaînes numériques (ex : "100.00")
Information
Les identifiants d'entités (idYear, idEntry, idAccount, etc.) sont passés dans les paramètres d'URL (ex :
:idOrganization, :idYear). L'organisation est identifiée via le token d'authentification ou l'en-tête X-Organization-Id, et non dans le corps de la requête.Attention
Les chemins affichés dans cette documentation n'incluent pas le préfixe de version
/v1. Utilisez toujours la dernière version du CLI Arrhes pour bénéficier automatiquement du bon préfixe de version. Si vous appelez l'API directement, préfixez chaque chemin avec /v1.Authentification
Toutes les routes documentées ici sont protégées et nécessitent une authentification.
Voir les méthodes d'authentificationGestion des erreurs
Toutes les erreurs sont retournées avec un message en français :
| Code | Signification |
|---|---|
| 400 | Requête invalide - erreur de validation, règle métier non respectée |
| 401 | Non autorisé - session manquante/invalide, permissions insuffisantes |
| 404 | Non trouvé - la route n'existe pas |
| 500 | Erreur interne du serveur |
Les messages d'erreur courants incluent :
| Message | Signification |
|---|---|
| "Vous n'êtes pas administrateur de l'organisation" | Accès administrateur requis |
| "Données invalides" | La validation du corps de la requête a échoué |
| "Fichier trop volumineux" | Le fichier dépasse la limite de 50 Mo |
| "Limite de stockage atteinte" | Limite de stockage de l'organisation atteinte |
Catégories de routes
L'API expose 110 routes protégées réparties en 19 catégories. Le tableau ci-dessous résume chaque catégorie :
| # | Catégorie | Routes | Scope |
|---|---|---|---|
| 1 | Organisations | 3 | Utilisateur |
| 2 | Paramètres d'organisation | 3 | Organisation |
| 3 | Clés API | 3 | Organisation |
| 4 | Abonnement et paiements | 17 | Organisation |
| 5 | Utilisateurs d'organisation | 5 | Organisation |
| 6 | Exercices | 9 | Organisation / Exercice |
| 7 | Comptes | 5 | Exercice |
| 8 | Journaux | 5 | Exercice |
| 9 | Bilans | 5 | Exercice |
| 10 | Comptes de résultat | 5 | Exercice |
| 11 | Calculs | 5 | Exercice |
| 12 | Calculs - comptes de résultat | 5 | Exercice |
| 13 | Libellés d'écriture | 5 | Exercice |
| 14 | Écritures | 10 | Exercice |
| 15 | Lignes d'écriture | 6 | Exercice |
| 16 | Tags d'écriture | 2 | Exercice |
| 17 | Fichiers | 10 | Exercice |
| 18 | Dossiers | 5 | Exercice |
| 19 | Rapports XBRL | 2 | Exercice |