Aller au contenu principal

Bienvenue sur l'API Scribee

Au 1er septembre 2026, toute entreprise assujettie à la TVA en France doit être en mesure de recevoir des factures électroniques, et les grandes entreprises comme les entreprises de taille intermédiaire doivent en émettre ; au 1er septembre 2027, l'obligation d'émission s'étend à toutes les entreprises. Si votre logiciel crée, reçoit ou gère des factures pour ces entreprises, il doit se raccorder au dispositif national. Scribee est une Plateforme Agréée pour la réforme de la facturation électronique. Votre système se connecte à une API REST qui crée, contrôle et met en forme vos factures électroniques, suit leurs statuts de cycle de vie et rassemble vos données d'e-reporting. Cette page vous permet de vérifier que la couverture correspond à votre besoin, puis d'obtenir un accès.

Ce que Scribee fait pour vous​

  • Conversion de formats : vous créez une facture en JSON structuré ou vous déposez un fichier existant (UBL 2.1, CII EN16931, Factur-X - PDF avec XML embarqué) ; chaque facture se télécharge ensuite au format pdf, ubl, cii ou facturx.
  • Conformité Factur-X : Scribee génère le PDF/A-3 avec le XML CII embarqué. Quand vous fournissez votre propre PDF, la conformité du fichier produit est contrôlée et le résultat est exposé sur la facture (facturx_conformance : pending, compliant, non_compliant) ; sur une facture générée par Scribee, ce champ vaut null.
  • Cycle de vie AIFE (Agence pour l'informatique financière de l'État) : les statuts réglementaires sont suivis sur vos factures de vente comme sur vos factures d'achat - 200 déposée, 202 reçue, 205 approuvée, 210 refusée, 213 rejetée, 220 annulée. Vous déclarez par l'API les transitions ouvertes à un partenaire, Scribee vérifie qu'elles sont permises depuis l'état courant, et l'historique des événements porte pour chacun sa date, son statut et son motif. Les états que la plateforme écrit elle-même - 202 reçue, 213 rejetée, 220 annulée - vous sont rapportés, pas déclarés : Cycle de vie d'une facture donne la liste exacte.
  • Origine des documents : chaque facture porte le canal par lequel elle est entrée dans le workspace (upload_source).
  • E-reporting : vous enregistrez les transactions, les paiements et les factures hors facturation électronique obligatoire - ventes B2C, opérations B2B transfrontalières - dans des périodes décadaires, mensuelles ou bimestrielles selon le régime de TVA de l'entreprise.
  • Notifications : des webhooks poussent vers votre système la création d'une facture et les changements de statut de son cycle de vie, avec signature des requêtes et rotation du secret.

Le parcours d'une facture​

Votre système parle uniquement à Scribee. L'API ne transmet pas les documents sur le réseau réglementaire : elle les crée, les contrôle, les met en forme et enregistre les statuts que vous déclarez. Aucun appel de l'API /api/v1/** ne transmet une facture vers le portail public de facturation ni vers Peppol - cet acheminement se pilote depuis l'interface Scribee. Un envoi reste possible par un autre canal : POST /api/v1/invoices/{id}/send_by_email adresse la facture par e-mail au destinataire que vous indiquez. Le PDF est toujours joint ; le Factur-X ne l'est que si la facture en porte déjà un.

Cinq domaines fonctionnels​

Les guides et la référence API suivent le même découpage en cinq domaines. Tous les endpoints sont sous /api/v1/.

DomaineCe qu'il couvre
FacturationFactures de vente et d'achat conformes EN16931, devis et leur conversion en facture, paiements rapprochés, justificatifs joints au Factur-X sortant. Point d'entrée : Factures.
E-reportingRapports périodiques et leurs transactions, paiements et factures. Point d'entrée : E-reportings.
AnnuaireClients, fournisseurs, vos entreprises (SIREN, SIRET, TVA) et leurs établissements, invitations de mise à jour envoyées à vos tiers, et l'annuaire national des adresses électroniques. Point d'entrée : Recherche dans l'annuaire.
ConformitéLe mandat qui autorise Scribee à émettre et recevoir pour le compte d'une entreprise, son circuit de signature électronique et ses documents KYC (extrait Kbis, pièce d'identité, preuve de capacité à signer). Point d'entrée : Mandats.
PlateformeWorkspaces, membres, catégories, webhooks et l'endpoint de disponibilité GET /api/v1/health. Point d'entrée : Workspaces.

Le module de comptabilité se gère depuis l'interface Scribee et n'est pas exposé dans l'API.

L'accès à l'API​

L'API est servie sur https://app.scribee.tech. L'authentification est OAuth 2.0 en client credentials : un access token obtenu sur POST /oauth/token donne accès aux workspaces accordés à votre application. GET /api/v1/workspaces est le premier appel : les endpoints qui listent ou créent des ressources sont imbriqués sous un workspace, tandis que ceux qui portent sur une ressource déjà identifiée la référencent directement par son id.

Deux jeux de scopes sont couramment accordés : read pour un accès en lecture seule, read write pour lire et écrire. Les lectures exigent read et les écritures write, une suppression acceptant destroy ou write ; le détail de ce que le serveur vérifie est dans Authentification.

Trois faits structurent l'intégration :

  • L'accès est accordé, il n'est pas en libre-service. Un administrateur Scribee valide votre demande, crée le client OAuth et vous transmet le client_id et le client_secret. Il n'y a ni formulaire d'inscription ni console développeur ; la rotation d'un secret se demande à la même équipe.
  • Vous intégrez la production. Il n'existe pas d'environnement de test : vos appels portent sur votre compte de production. Certains appels envoient un e-mail réel à un tiers - envoi d'une facture ou d'un devis, invitation de mise à jour d'un client ou d'un fournisseur, mise en signature d'un mandat. Chaque guide d'écriture le signale avant le premier bloc de code. L'état draft des factures et des devis permet de construire un document sans déclencher aucun de ces envois.
  • L'API est versionnée en bloc. Toutes les ressources vivent sous /api/v1/ ; un changement incompatible sortirait sous /api/v2/, jamais en modification de v1.

Les conventions communes à tous les endpoints (pagination, tri, formats d'erreur) sont regroupées dans Conventions de l'API.

Devenir partenaire​

Le point de départ est un échange avec l'équipe Scribee : présentez votre cas d'usage (sens des flux, volumes, logiciel que vous connectez) et demandez un accès API. Un administrateur Scribee crée alors votre client OAuth avec les scopes correspondant à votre usage et vous transmet vos identifiants. C'est la même équipe qui vous accompagne ensuite : évolutions de scopes, rotation de secret et questions d'intégration passent par elle.

Votre parcours d'intégration​

  1. Authentification : obtenez un access token avec vos identifiants OAuth.
  2. Votre premier appel : listez vos workspaces et vérifiez votre périmètre d'accès.
  3. Entreprises et établissements : déclarez les entités légales (SIREN, SIRET) pour lesquelles vous facturez.
  4. Mandats de facturation électronique : faites signer le mandat qui autorise Scribee à agir pour chaque entreprise.
  5. L'annuaire national : publiez les adresses électroniques de vos entreprises et cherchez celles de vos destinataires.
  6. Émettre une facture de vente : créez la facture, déposez-la et suivez ses statuts du dépôt à l'encaissement.