Skip to main content

SmartDoc API & MCP

SmartDoc offre un acces programmatique complet a toutes vos donnees de documentation via une API REST publique et un serveur MCP (Model Context Protocol). Ces interfaces permettent aux outils d'IA, scripts d'automatisation et integrations tierces de lire, creer et gerer vos donnees SmartDoc de maniere securisee.

Architecture

                         Cle API (sk-smartdoc-...)
|
+-----------+-----------+
| |
API REST v1 Serveur MCP
/api/v1/{entite} /mcp (HTTP)
| |
+-----------+-----------+
|
Base de donnees
(isolation par tenant)

Les deux interfaces partagent la meme authentification par cle API et les memes regles d'acces :

InterfaceURLUsage
API RESThttps://smartdoc.mspsmart.ca/api/v1/Scripts, automatisations, integrations
Swagger UIhttps://smartdoc.mspsmart.ca/api/v1/docs/Documentation interactive des endpoints
MCPhttps://smartdoc.mspsmart.ca/mcpClaude Desktop, Cursor, outils IA

Fonctionnalites

API REST (/api/v1/)

  • 22 types d'entites avec CRUD complet (List, Get, Create, Update, Delete)
  • Recherche globale cross-entites (/api/v1/search?q=...)
  • Pagination configurable (page, limit, tri, filtres)
  • Rate limiting : 1 000 requetes/heure par cle
  • Documentation Swagger auto-generee

Serveur MCP (/mcp)

  • ~68 outils MCP auto-generes depuis le meme registre que l'API REST
  • Protocole Streamable HTTP compatible Claude Desktop et Cursor
  • Recherche et whoami comme outils speciaux
  • Gestion de session avec nettoyage automatique (30 min d'inactivite)

Entites disponibles

CategorieEntites
Contenudocuments, document-types, kb-articles, kb-categories, changelogs
Securitecredentials, vpn, wifi
IT Assetsassets, asset-types, certificates, applications, serials, racks
Reseaunetwork-diagrams
Organisationcompanies, folders, entity-links, agreements
Processusprocesses, websites, photos

Chaque entite supporte : LIST (avec pagination, recherche, tri), GET (par ID), CREATE, UPDATE et DELETE (selon la portee de la cle).

Niveaux d'acces

Chaque cle API possede une portee (scope) qui determine les operations autorisees :

OperationRead OnlyRead/WriteFull Access
GET — Lister, consulter, rechercher
POST — Creer des ressources
PATCH — Modifier des ressources
DELETE — Supprimer des ressources
Recommandation

Utilisez Read Only pour les outils d'IA et tableaux de bord. Reservez Full Access uniquement aux scripts d'administration qui necessitent la suppression.

Securite

  • Cles API avec prefixe sk-smartdoc- pour identification rapide
  • Double hachage : SHA-256 (lookup rapide) + bcrypt (verification securisee)
  • Cache Redis avec TTL de 5 minutes pour les performances
  • Isolation multi-tenant : chaque cle est liee a un seul tenant
  • Filtrage par compagnie : limitez l'acces a certaines compagnies clientes
  • Audit complet : toutes les operations d'ecriture sont journalisees

Prochaines etapes

  • Cles API — Creer et gerer vos cles d'acces
  • API REST — Reference des endpoints REST
  • Serveur MCP — Connecter Claude Desktop et Cursor