API Présentation
PrimeCal API Référence
La carte API non-administrateur
Cette référence est construite directement à partir des contrôleurs backend et des DTO. Il documente le API face à l'utilisateur et à l'intégration fait surface et exclut intentionnellement les contrôleurs d'administration et les itinéraires réservés aux administrateurs.
Chemin de base : /apiJWT, cookie, clé API et authentification de l'agentContraintes DTO basées sur du codeSurface d'administration exclue
Portée
- Inclus : contrôleurs non-administrateurs et itinéraires de produits non-administrateurs
- Exclus : contrôleurs
/api/admin/*et routes non/adminprotégées parAdminGuard
URL de base et modèle d'authentification
| Sujet | Remarques |
|---|---|
| Chemin de base | Tous les exemples supposent /api |
| Interface utilisateur Swagger | Le Swagger généré peut être servi à /api/docs lorsqu'il est activé |
| Sessions de navigateur | Utilisez les cookies d'actualisation plus CSRF pour les demandes de mutation |
| Authentification au porteur | Authorization: Bearer <token> |
| Clés utilisateur API | Pris en charge sur les itinéraires gardés par JwtAuthGuard ; envoyer x-api-key ou Authorization: ApiKey <token> |
| Clés d'agent | Requis pour le runtime MCP ; envoyer x-agent-key, x-agent-token ou Authorization: Agent <token> |
Carte de référence du domaine produit
| Pages | Domaine de produits | Points forts |
|---|---|---|
| Authentification API | Authentification | inscription, connexion, intégration, MFA, OAuth, utilisateur API clés |
| Utilisateur API | Utilisateur et profil | paramètres de profil, langue, autorisations, recherche d'utilisateurs |
| Journaux personnels API | Journaux personnels | flux d'audit et résumé |
| Conformité API | Confidentialité et conformité | exportations, demandes, consentements, acceptation des politiques |
| Calendrier API | Calendrier | calendriers, groupes, partage |
| Événement API | Événements | événement CRUD, récurrence, commentaires |
| Tâches API | Tâches | tâches, étiquettes, filtrage |
| Automatisation API | Automatisation | règles, journaux d'audit, approbations, déclencheur de webhook |
| Synchronisation externe API | Synchronisation externe | statut du fournisseur, OAuth, mappages, synchronisation forcée |
| Agent API | Agents IA et MCP | agents, étendues, clés, runtime MCP |
| Notifications API | Notifications | boîte de réception, préférences, règles, muets, fils de discussion |
| Organisation API | Organisations | adhésion, rôles, couleur, aperçu de la suppression |
| Ressource API | Ressources | types de ressources, ressources, jetons publics |
| Réservation API | Réservations et réservation publique | calendriers de réservation, réservations, réservation publique |
| Plateforme API | Plateforme | santé, indicateurs, mesures, rapports de sécurité |
Exemples de démarrage rapide
Authentification au porteur
export PRIMECAL_API=https://api.primecal.eu
curl "$PRIMECAL_API/api/calendars" \
-H "Authorization: Bearer $TOKEN"
Clé utilisateur API
curl "$PRIMECAL_API/api/tasks" \
-H "Authorization: ApiKey $USER_API_KEY"
Clé d'agent
curl "$PRIMECAL_API/api/mcp/actions" \
-H "Authorization: Agent $AGENT_KEY"
Meilleures pratiques
- Regroupez le code client par domaine de produit, et pas seulement par chemin de contrôleur.
- Utilisez les contraintes DTO de ces pages comme source de vérité de votre demande-contrat.
- Traitez les routes réservées aux administrateurs comme une surface de documentation distincte.
- Créez des interfaces utilisateur d'intégration à partir des points de terminaison du catalogue en direct là où ils existent, tels que les valeurs intelligentes d'automatisation ou le catalogue d'agents.