Développeurs

API — Docs

Référence API — Docs

Docs est le traitement de texte collaboratif (type Google Docs) : arborescence de documents, édition collaborative temps réel (Yjs), commentaires, partage par lien, IA.

  • Base URL — prod : https://docs.api.puwapi.com · dev : http://localhost:6100
  • Auth : JWT + gating docs (Business+). Partage par lien = anonyme.

Arborescence (nodes)

Base : /api/docs/nodes — dossiers et documents.

MéthodeRouteRôle
GET/api/docs/nodesLister l'arbre
GET/api/docs/nodes/trashCorbeille
GET/api/docs/nodes/recentRécents
GET/api/docs/nodes/{id}/breadcrumbFil d'Ariane
POST/api/docs/nodesCréer un dossier / document
PATCH/api/docs/nodes/{id}Renommer / déplacer
DELETE/api/docs/nodes/{id}Mettre à la corbeille
POST/api/docs/nodes/{id}/restoreRestaurer

Édition d'un document

Base : /api/docs/documents

MéthodeRouteRôle
GET/api/docs/documents/{id}/sessionSession d'édition collaborative
PUT/api/docs/documents/{id}/snapshotSauvegarder un instantané

L'édition en temps réel repose sur Yjs (CRDT) ; le serveur conserve des instantanés.

Commentaires

MéthodeRoute
GET/POST/api/docs/documents/{id}/comments
POST/api/docs/documents/{id}/comments/{commentId}/resolve
DELETE/api/docs/documents/{id}/comments/{commentId}

Partage

Base : /api/docs (routes de partage [AllowAnonymous] pour l'accès par lien)

MéthodeRouteRôle
GET/POST/api/docs/nodes/{id}/permissionsPermissions par utilisateur
DELETE/api/docs/nodes/{id}/permissions/{permId}Retirer une permission
GET/POST/api/docs/nodes/{id}/share-linksLiens de partage
DELETE/api/docs/share-links/{linkId}Révoquer un lien
GET/api/docs/{token}Ouvrir un document via un lien de partage

IA

MéthodeRouteRôle
GET/api/docs/documents/ai/statusÉtat de l'IA
POST/api/docs/documents/{id}/ai/generateGénération (branchée sur le module IA)

Le bouton « Résumé IA » du Hub passe par la feature doc_summary du module IA.

Route interne (M2M)

/api/docs/internal/{provision,rename,delete} — provision de documents depuis un autre contexte. X-Internal-Secret.

#api #docs