Documents du développeur PrimeCal

Basé sur un code API Référence par domaine de produit

Cette section reflète la carte réelle des fonctionnalités du produit. Il documente directement le backend non administrateur à partir des contrôleurs NestJS et des DTO, avec des contraintes de requête, des notes d'authentification, des exemples d'appels et mises en garde concernant la mise en œuvre.

Portée non-administrateurSupporté par un contrôleurJWT, clé API et authentification de l'agentMCP inclus

Commencez ici

Présentation

Présentation de l'API

Chemin de base, modes d'authentification, règles de portée et carte complète de la zone produit.

Authentification

API d'authentification

Inscription, intégration, connexion, MFA, OAuth, flux d'actualisation et clés utilisateur API.

Profil

API utilisateur

Paramètres du profil, langue, démarrage des autorisations et aides au partage.

Automatisation

API d'automatisation

Règles, déclencheurs, conditions, actions, journaux d'audit, approbations et webhooks.

Agents IA

API de l'agent

Agent CRUD, autorisations étendues, clés émises et points de terminaison d'exécution MCP.

Domaines de produits

Planification

Calendrier, Événements, Tâches

Calendriers, groupes, partage, CRUD et récurrence des événements, commentaires, CRUD des tâches et étiquettes.

Intégrations

Synchronisation externe

État du fournisseur, transfert OAuth, mappage de calendrier externe, déconnexion et synchronisation manuelle.

Contrôles utilisateur

Notifications, Journaux personnels, Conformité

Boîte de réception et préférences, flux et résumé d'audit, exportations de confidentialité, demandes et consentements.

Domaine de planification

Organisations, Ressources, Réservation

Organisations, rôles, ressources, calendriers de réservation, réservations et réservations publiques.

Plateforme

API de la plateforme

Santé, préparation, indicateurs de fonctionnalités, surveillance, ingestion d'erreurs frontales et rapports de sécurité.

Chemin de lecture recommandé

1. Lisez API Présentation.
2. Choisissez la zone de produit qui correspond à la fonctionnalité destinée à l'utilisateur que vous créez.
3. Utilisez les tables de points de terminaison et les règles DTO avant de câbler les demandes des clients.
4. Traitez tout ce qui se trouve sous les contrôleurs d'administration comme une surface de documentation distincte.

Interface utilisateur Swagger

Lorsqu'elle est activée par le backend, l'interface utilisateur Swagger générée est servie à /api/docs. Les déploiements de production peuvent placer l'authentification HTTP Basic devant cette route.