API

Référence API REST

Accédez aux données OrgaBox via l'API REST. Authentification par clé API ou OAuth 2.0.

Authentification

Toutes les requêtes doivent inclure un en-tête Authorization: Bearer <votre_clé_api>. Vous pouvez générer une clé API depuis les paramètres de votre compte OrgaBox (Profil → Sécurité → Clés API). Base URL : https://api.orgabox.fr.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.orgabox.fr/v1/me

Endpoints principaux

Voici les principaux endpoints disponibles. La réponse est au format JSON. Les paginations utilisent les paramètres page et per_page (max 100).

  • GET/v1/me— Profil de l'utilisateur connecté
  • GET/v1/documents— Liste des documents (GED)
  • POST/v1/documents— Créer / déposer un document
  • GET/v1/documents/:id— Détail d'un document
  • GET/v1/projects— Liste des projets
  • POST/v1/projects— Créer un projet
  • GET/v1/invoices— Liste des factures
  • POST/v1/invoices— Créer une facture

Limites et support

Le taux de requêtes est limité à 1000 requêtes par heure par clé API (plan Business et Enterprise). Pour les besoins spécifiques (webhooks, volume élevé), contactez-nous via la page Contact.