Aller au contenu principal
Version: v1

Scribee API

L'API Partenaire Scribee est une API REST/JSON pour Scribee, une Plateforme Agréée française pour la réforme de la facturation électronique : factures, devis, mandats, e-reporting et l'annuaire clients/fournisseurs y sont tous accessibles.

L'authentification se fait en OAuth 2.0 client-credentials. Chaque jeton d'accès porte un ou plusieurs des trois scopes : read (accès en lecture aux ressources), write (création, modification, et suppression via DELETE sauf lorsque :destroy est exigé par le point de terminaison) et destroy (permission de supprimer des ressources via HTTP DELETE - une alternative de moindre privilège à write pour les points de terminaison destructifs). Demandez un jeton sur POST /oauth/token.

Tous les points de terminaison de ressources sont regroupés sous /api/v1/ et versionnés comme un tout - une rupture de compatibilite est publiée en /api/v2/, jamais comme une modification en place de v1.

Les guides lisibles par un humain (parcours d'authentification, panorama des ressources, webhooks) se trouvent dans docs/feature_registry/10_rest_api.md et docs/webhooks.md dans le dépôt Scribee.

Authentication​

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Token URL: /oauth/token

Scopes:

  • read: Read access to resources

  • write: Write access to resources (create, update, and DELETE unless :destroy is required by the endpoint)

  • destroy: Permission to delete resources via HTTP DELETE (least-privilege alternative to :write for destructive endpoints)