Aller au contenu
Documentation

API

Intégrer Docage à vos outils — les essentiels de l'API, la migration depuis la V1, l'intégralité de ses routes et la définition de chacun de ses objets.

3 min de lecture Mise à jour le 12 novembre 2026

L'API de Docage est une API REST qui échange du JSON. Son adresse :

https://staging-api.docage.com

Ce que l'application fait, l'API le fait aussi : chaque appel agit au nom d'un utilisateur, avec ses droits. Sa documentation se range en quatre menus, dans le sommaire : les essentiels, la migration depuis la V1, l'intégralité des routes et les définitions des objets.

Essentiels de l'API

Par où commencer

  1. Commencer : ce qu'il faut pour un premier appel, et les conventions de tous les échanges.
  2. S'authentifier, par un jeton ou par la clé API d'un utilisateur.
  3. Le démarrage rapide : un besoin courant, de la première requête au résultat, rangé par thème — la signature d'abord : envoyer un parcours à signer, télécharger les documents signés et la preuve, être prévenu de la signature ; puis les contacts et les cartes, les emails et les campagnes, les documents, et l'assistant IA d'un utilisateur, à qui votre logiciel peut confier des demandes.

L'environnement d'essai dit comment essayer une intégration sans rien consommer. Un agent IA qui écrit ou exécute votre intégration lit d'abord Intégrer avec un agent IA.

Les principes de base

Migration V1 > V2

Une intégration écrite pour la V1 de l'API, celle de 2025, se met à jour d'après Migration V1 > V2 : chaque rupture et ce qu'il faut faire, puis le tableau des routes déplacées ou retirées. Dans le sommaire, ce menu mène directement à chacune de ses parties.

Intégralité des routes

Le menu Intégralité des routes ouvre la référence de l'API : chaque route, ses paramètres, son corps et ses réponses, avec une console pour l'essayer.

Définitions des objets

Les définitions des objets décrivent chaque fiche que l'API lit et écrit : ses propriétés, ses énumérations et ses liaisons avec les autres fiches.

Une question ?

Quand Docage le propose, le bouton Demander à l'assistant, en bas à droite de la référence et en haut de chaque page de cette documentation, répond à vos questions sur l'API d'après cette documentation seule, en citant les pages qu'il a lues : voir l'assistant de la documentation.

Dans ce chapitre

  • Commencer

    Ce qu'il faut pour un premier appel à l'API, et les conventions de tous les échanges.

  • Intégrer avec un agent IA

    Ce qu'un agent IA, ou le développeur qui le guide, doit savoir avant d'écrire une intégration — où lire, comment s'authentifier, et les comportements de l'API qui ne se devinent pas.

  • S'authentifier

    Obtenir un jeton, ou utiliser la clé API d'un utilisateur.

  • Environnement d'essai

    Essayer une intégration sans rien consommer — ce qu'une organisation qui n'est pas encore en production permet, ce qu'elle refuse, et le parcours d'essai.

  • Démarrage rapide

    Un besoin courant, de la première requête au résultat, rangé par thème — la signature d'abord, puis les contacts, les emails et les documents.

  • Organisations et intégrateurs

    À quelle organisation appartient une fiche, et comment un intégrateur agit pour ses organisations clientes.

  • Lire des listes

    Filtrer, trier et paginer la liste d'un type de fiche, et n'en lire que les propriétés utiles.

  • Créer et modifier

    Ce qu'un POST et un PUT attendent, ce que le serveur écrit seul, et la corbeille.

  • Modèles et instances

    Partir d'un modèle plutôt que de zéro — lister les modèles, en tirer une fiche, créer un modèle.

  • Droits et visibilité

    Ce qu'un utilisateur voit et peut faire, et comment lire ou poser les droits d'une fiche.

  • Champs personnalisés

    Lire les champs propres à une organisation, et en écrire les valeurs.

  • Dates et fuseaux

    Toute date échangée est en UTC ; ce qui entre déclare son fuseau, ce qui s'affiche se convertit chez vous.

  • Erreurs

    Les codes d'état que l'API rend, et ce que porte le corps d'un refus.

  • Limites de débit

    Ce que l'API limite, ce qu'elle facture, et comment appeler sans gaspiller.

  • Rejouer une requête sans doublon

    Une création rejouée crée une seconde fiche : comment reprendre une requête interrompue sans rien doubler.

  • Webhooks

    Être prévenu par un appel à votre adresse quand une fiche change — s'abonner, vérifier la signature, répondre.

  • Composer un flux

    Créer, valider, essayer et suivre un flux d'automatisation par l'API — le contrat qu'un agent IA ou un script suit pour composer un flux sans passer par l'écran.

  • Temps réel

    Recevoir les messages des conversations d'un utilisateur dès qu'ils arrivent, par une connexion SignalR ouverte en son nom — se connecter, écouter, rattraper.

  • Approvisionner les comptes par SCIM

    Le serveur SCIM 2.0 d'une organisation — son adresse et son jeton, ses ressources, les filtres qu'il lit, et ce qu'un départ fait d'un compte.

  • Migration V1 > V2

    Ce qui change pour une intégration écrite pour la V1 de l'API, celle de 2025 — authentification, codes de refus, fiches, listes, parcours, webhooks — et ce qu'il faut faire.

  • Définitions des objets

    Chaque fiche que l'API lit et écrit — ses propriétés, ses énumérations et ses liaisons avec les autres fiches.