Référence des points de terminaison de service

Tous les chemins d’accès de cette page sont relatifs à :

https://api.champrep.com

Utilisez un identifiant « bearer » à portée limitée, comme décrit dans Authentification et clésAPI. Une route répertoriée reste soumise à la disponibilité actuelle du service, aux paramètres du forfait et de l’organisation, aux autorisations des rôles, à l’accès aux ressources et aux contrôles d’utilisation en temps réel.

Carte des services

Zone	Préfixe	Portées
Identité et profil	/v1/auth, /v1/users	users:read et le contexte des identifiants
Recherche sur l’ensemble des services	/v1/search	La portée de lecture de chaque service recherché
Drive	/v1/drive	drive:read, drive:write, drive:delete
Chat	/v1/chat	chat:read, chat:write
Calendar	/v1/calendar	calendar:read, calendar:write
Contacts	/v1/contacts	contacts:read, contacts:write
Meet	/v1/meet	meet:read, meet:write
Notes	/v1/notes	notes:read, notes:write
Learn	/v1/learn, /v1/courses	courses:read, courses:write
CHAMPREP AI	/v1/ai	ai:chat
Mail	/v1/mail	mail:read, mail:write, mail:send
Work	/v1/work	work:read, work:write, work:delete
Org Chart	/v1/charts	charts:read, charts:write, charts:delete
Forms	/v1/forms	forms:read, forms:write
Invoice	/v1/invoice	invoice:read, invoice:write, invoice:send, invoice:delete
CHAMPREP QA	/v1/qa	qa:read, qa:write
CHAMPREP Business	/v1/business	business:read, business:manage
Facturation	/v1/billing	billing:read, billing:manage
Webhooks	/v1/webhooks	webhooks:manage

GET, HEAD, et OPTIONS nécessitent généralement le périmètre de lecture. Les méthodes de création, de mise à jour et d’action nécessitent le périmètre d’écriture ou de gestion. Les méthodes de suppression nécessitent un périmètre de suppression lorsque le service en définit un. Une route peut nécessiter des autorisations supplémentaires liées aux rôles ou aux ressources dans le service de destination.

Identité et état de la passerelle

Méthode	Parcours	Objectif
GET	/v1/version	Afficher les informations relatives à la version publique de Gateway.
GET	/v1/auth/whoami	Renvoyer le contexte de l’utilisateur actif, du profil, des identifiants et du forfait.
GET	/v1/auth/quota	Afficher la clé actuelle et l’instantané du quota de la passerelle.
GET	/v1/users/me	Afficher le profil de l’utilisateur actuel.
GET	/v1/users/me/notifications	Afficher la liste des notifications visibles par l’utilisateur actuel.

L’échangeCLI assisté par navigateur utilise également /v1/auth/cli/start, /v1/auth/cli/device, et /v1/auth/cli/poll. Ces routes sont implémentées par l’application officielle CLI; les applications personnalisées ne doivent pas imiter le protocole d’approbationCLI lorsqu’une cléAPI répond à leurs besoins.

Recherche sur l’ensemble des services

Méthode	Parcours	Portée	Objectif
GET	/v1/search	Par service, voir ci-dessous	Effectuez une recherche sur tous les services accessibles avec ces identifiants, en un seul appel.
GET	/v1/search/services	Aucun	Indiquez les services que cet identifiant permet d’interroger.

/v1/search La requête est répartie entre les services prenant en charge la recherche et les résultats sont fusionnés. Paramètres :

Paramètre	Par défaut	Objectif
q	obligatoire	Le terme de recherche.
limit	5	Nombre maximal de résultats par service, jusqu’à 20.
services	tout	Liste séparée par des virgules, par exemple mail,drive. Cela permet de réduire le nombre de requêtes.
semantic	false	Configurer true pour reclasser les résultats à l’aide de l’IA et obtenir une réponse concise. Cela utilise vos propres crédits IA.

Recherche intelligente avec IA

semantic=true ajoute un passage IA aux résultats dont vous disposez déjà : il analyse votre question, réorganise les résultats en fonction de leur pertinence par rapport à celle-ci, ajoute une brève justification à chacun d’entre eux, et renvoie un paragraphe answer.

Ce service est facturé sur vos propres crédits IA — le même forfait mensuel que celui CHAMPREP AIutilisé par l’assistant. Aucun frais n’est facturé à moins que vous ne le demandiez, et la recherche par mot-clé ne coûte jamais de crédits IA.

Chaque réponse indique ce qui s’est passé dans semantic:

"semantic": { "requested": true, "applied": true, "answer": "..." }

Lorsque le passage IA ne peut pas s’exécuter, les résultats de vos mots-clés sont renvoyés tels quels et semantic explique pourquoi :

reason	Signification
AI_CREDITS_EXHAUSTED	Vous avez utilisé tous vos crédits IA mensuels.
PLAN_NO_AI	Votre forfait ne comprend pas le service IA.
AI_UNAVAILABLE	Le service IA n’était pas accessible cette fois-ci.

Un passage IA infructueux n’entraîne jamais l’échec de la recherche. Appelez /v1/search/services d’abord pour vérifier si la recherche intelligente est disponible — elle affiche semantic.available ainsi que vos crédits restants — et masquez l’option IA lorsqu’elle n’est pas disponible.

Un service n’est inclus que lorsque l’identifiant dispose d’une autorisation de lecture sur celui-ci (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) et si le forfait actif le permet. Ces deux vérifications échouent si le service est « fermé » ; ainsi, un service que vous ne pouvez pas utiliser ne contribue jamais aux résultats.

Chat Les messages sont chiffrés au repos et ne font l’objet d’une recherche qu’au sein des salles auxquelles vous appartenez, en portant sur l’historique récent plutôt que sur l’intégralité des archives.

curl -H "Authorization: Bearer $CHAMPREP_API_KEY" \
  "https://api.champrep.com/v1/search?q=roadmap&services=mail,notes&limit=3"

Les résultats sont regroupés par service et normalisés dans un format unique, de sorte qu’un client affiche chaque service de la même manière :

{
  "success": true,
  "data": {
    "query": "roadmap",
    "groups": [
      {
        "service": "notes",
        "label": "Notes",
        "results": [
          { "id": "6650...", "title": "Q3 roadmap", "subtitle": "Planning notes for...", "timestamp": "2026-08-02T10:14:00Z" }
        ]
      }
    ],
    "totalResults": 1,
    "searched": ["notes", "mail"],
    "skipped": [{ "service": "drive", "reason": "INSUFFICIENT_SCOPE" }],
    "cost": 2
  }
}

Lire skipped avant de considérer un résultat vide comme « rien trouvé ». Chaque entrée explique pourquoi un service a été omis — INSUFFICIENT_SCOPE, NOT_IN_PLAN, ou SERVICE_UNAVAILABLE lorsqu’un backend était trop lent ou brièvement inaccessible. Un service indisponible n’entraîne jamais l’échec de la requête dans son ensemble ; le reste des résultats est tout de même renvoyé.

Combien coûte une recherche ?

Une recherche interroge un service par groupe de résultats ; elle est donc facturée de cette manière : une unité de limitation de débit par service effectivement recherché. Le cost Le champ présent dans chaque réponse vous indique exactement ce qui a été facturé, et X-RateLimit-Remaining reflète cette situation avant même que vous ne receviez la réponse.

Requête	Services recherchés	Coût
?q=roadmap avec un forfait comprenant les huit	8	8
?q=roadmap&services=mail	1	1
?q=roadmap avec un forfait comprenant uniquement Notes	1	1

Vous n’êtes jamais facturé pour un service que vous ne pouvez pas utiliser ; par conséquent, affiner la recherche à l’aide de services est le moyen le plus économique de garantir la réactivité d’une recherche interactive. Veillez toujours à appliquer un délai de rebond — n’envoyez jamais de requête à chaque frappe.

Drive

Méthode	Parcours	Portée	Objectif
GET	/v1/drive/files	drive:read	Répertorier ou rechercher des fichiers. Utiliser la search Effectuer une requête si nécessaire.
GET	/v1/drive/folders	drive:read	Afficher le contenu du dossier racine.
GET	/v1/drive/folders/{folderId}	drive:read	Afficher le contenu d’un dossier.
GET	/v1/drive/starred	drive:read	Afficher la liste des éléments favoris.
GET	/v1/drive/recent	drive:read	Afficher la liste des éléments récents.
GET	/v1/drive/shared	drive:read	Afficher la liste des éléments partagés.
GET	/v1/drive/quota	drive:read	Afficher l’utilisation actuelle de l’espace de stockage et la capacité disponible.
POST	/v1/drive/upload	drive:write	Créer une destination de téléchargement.
POST	/v1/drive/files	drive:write	Enregistrer les métadonnées du fichier une fois le téléchargement terminé.
POST	/v1/drive/download	drive:read	Créer une destination de téléchargement.
POST	/v1/drive/folders	drive:write	Créer un dossier.
POST	/v1/drive/rename	drive:write	Déplacer ou renommer un élément.
POST	/v1/drive/delete	drive:delete	Supprimer un ou plusieurs éléments.
DELETE	/v1/drive/files/{fileId}	drive:delete	Supprimer un fichier via la procédure héritée de suppression d’un élément unique.

Le téléchargement est une opération en plusieurs étapes : demander une cible de téléchargement, transférer les octets vers cette cible, puis enregistrer les métadonnées résultantes. Utilisez la méthode officielle ouSDK CLI lorsque vous n’avez pas besoin de mettre en œuvre cette séquence vous-même.

Chat

Méthode	Parcours	Portée	Objectif
GET	/v1/chat/rooms	chat:read	Répertorier les salles visibles par le profil actif.
GET	/v1/chat/rooms/{roomId}	chat:read	Consulter une salle.
POST	/v1/chat/rooms	chat:write	Créer une salle.
GET	/v1/chat/rooms/{roomId}/messages	chat:read	Répertorier les messages de la salle.
POST	/v1/chat/rooms/{roomId}/messages	chat:write	Envoyer un message à la salle.
GET	/v1/chat/messages/search	chat:read	Rechercher des messages.
GET	/v1/chat/unread	chat:read	Renvoyer le nombre de messages non lus.
GET	/v1/chat/favorites	chat:read	Répertorier les messages favoris.

Calendar

Méthode	Parcours	Portée	Objectif
GET	/v1/calendar/events	calendar:read	Répertorier les événements ; prend en charge startDate et endDate Requêtes.
GET	/v1/calendar/events/{eventId}	calendar:read	Consulter un événement.
POST	/v1/calendar/events	calendar:write	Créer un événement.
PATCH	/v1/calendar/events/{eventId}	calendar:write	Mettre à jour un événement.
DELETE	/v1/calendar/events/{eventId}	calendar:write	Supprimer un événement.
GET	/v1/calendar/upcoming	calendar:read	Répertorier les réunions à venir.
GET	/v1/calendar/invitations	calendar:read	Répertorier les invitations en attente.

Envoyez les horodatages des événements au format ISO 8601 avec un fuseau horaire explicite. La création et la mise à jour des événements consomment le quota configuré pour le forfait actif et l’organisation ; le APIne définit pas de limite universelle fixe par forfait.

Contacts

Méthode	Parcours	Portée	Objectif
GET	/v1/contacts	contacts:read	Afficher la liste des contacts.
GET	/v1/contacts/search	contacts:read	Rechercher des contacts à l’aide de q ou email.
GET	/v1/contacts/favorites	contacts:read	Répertorier les favoris.
GET	/v1/contacts/labels	contacts:read	Afficher la liste des étiquettes.
GET	/v1/contacts/{contactId}	contacts:read	Consulter un contact.
POST	/v1/contacts	contacts:write	Ajouter un contact.
PUT	/v1/contacts/{contactId}	contacts:write	Mettre à jour les métadonnées d’un contact.
DELETE	/v1/contacts/{contactId}	contacts:write	Supprimer un contact.

Meet

Méthode	Parcours	Portée	Objectif
GET	/v1/meet/rooms	meet:read	Répertorier les salles de réunion.
GET	/v1/meet/rooms/{roomId}	meet:read	Consulter une salle.
POST	/v1/meet/rooms	meet:write	Créer une salle.
GET	/v1/meet/sessions	meet:read	Répertorier les sessions de réunion.
GET	/v1/meet/sessions/{sessionId}/participants	meet:read	Répertorier les participants à la session.
GET	/v1/meet/recordings	meet:read	Répertorier les enregistrements disponibles.
GET	/v1/meet/transcriptions	meet:read	Répertorier les transcriptions.
GET	/v1/meet/transcriptions/{sessionId}	meet:read	Consulter la transcription d’une session finale.
GET	/v1/meet/usage	meet:read	Renvoyer l’utilisation actuelle des réunions.

L’accès aux enregistrements et aux transcriptions dépend de la propriété de la réunion, du consentement, de la durée de conservation, du forfait et de la politique de l’organisation.

Notes

Méthode	Parcours	Portée	Objectif
GET	/v1/notes	notes:read	Répertorier les notes.
GET	/v1/notes/shared	notes:read	Répertorier les notes partagées avec le profil actif.
GET	/v1/notes/{noteId}	notes:read	Consulter une note.
POST	/v1/notes	notes:write	Créer une note.
PATCH	/v1/notes/{noteId}	notes:write	Mettre à jour une note.
DELETE	/v1/notes/{noteId}	notes:write	Supprimer une note.
POST	/v1/notes/{noteId}/share	notes:write	Partager une note à l’aide des paramètres d’accès pris en charge.

Learn et les cours

/v1/learn et /v1/courses mettre à disposition les mêmes parcours de cours sélectionnés.

Méthode	Parcours	Portée	Objectif
GET	/v1/learn	courses:read	Afficher la liste des cours disponibles.
GET	/v1/learn/enrolled/my	courses:read	Répertorier les inscriptions de l’utilisateur actif.
GET	/v1/learn/{courseId}	courses:read	Consulter un cours.
GET	/v1/learn/{courseId}/sections	courses:read	Afficher la liste des sections de cours.
POST	/v1/learn	courses:write	Créer un cours lorsque le rôle l’autorise.
PUT	/v1/learn/{courseId}	courses:write	Mettre à jour un cours lorsque le rôle l’autorise.

Utilisez le /v1/courses Utilisez plutôt le préfixe lors de la maintenance d’une intégration qui utilise déjà cet alias.

CHAMPREP AI

Méthode	Parcours	Portée	Objectif
POST	/v1/ai/chat	ai:chat	Envoyer une invite ou une charge utile de conversation prise en charge.
GET	/v1/ai/conversations	ai:chat	Afficher la liste des conversations enregistrées.
GET	/v1/ai/conversations/{conversationId}	ai:chat	Lire une conversation.
DELETE	/v1/ai/conversations/{conversationId}	ai:chat	Supprimer une conversation.
GET	/v1/ai/usage	ai:chat	Renvoyer l’utilisation actuelle de l’IA.

Les résultats générés par l’IA peuvent être incomplets ou incorrects. Vérifiez les résultats importants et n’ envoyez pas de données que l’utilisateur actif n’est pas autorisé à divulguer.

Mail

Méthode	Parcours	Portée	Objectif
GET	/v1/mail/accounts	mail:read	Répertorier les comptes de messagerie connectés.
GET	/v1/mail/emails	mail:read	Répertorier les messages.
GET	/v1/mail/emails/{emailId}	mail:read	Lire un message.
GET	/v1/mail/threads	mail:read	Répertorier les fils de discussion.
GET	/v1/mail/threads/{threadId}	mail:read	Lire un fil de discussion.
POST	/v1/mail/send	mail:send	Envoyer un message.
GET	/v1/mail/domains	mail:read	Répertorier les domaines de messagerie visibles.

Work

L’interface « GatewayWork » reflète la version prise en charge de sousWorkAPI /v1/work. La passerelle détermine la portée requise à partir de la méthode HTTP :

• Les méthodes de lecture nécessitent work:read.
• Les méthodes « create » et « update » nécessitent work:write.
• Les méthodes de suppression ainsi que les actions massives destructrices ou d’annulation d’importation nécessitent work:delete.

Les routes courantes comprennent :

Méthode	Parcours	Objectif
GET, POST	/v1/work/boards	Répertorier ou créer des tableaux.
GET, PUT, DELETE	/v1/work/boards/{boardId}	Lire, mettre à jour ou archiver un tableau.
GET	/v1/work/boards/{boardId}/kanban	Lire la vue Kanban du tableau.
GET	/v1/work/boards/{boardId}/export/csv	Exporter un tableau au format CSV.
GET	/v1/work/boards/{boardId}/export/json	Exporter un instantané structuré du tableau.
GET, POST	/v1/work/tickets	Rechercher ou créer des tickets.
GET, PUT, DELETE	/v1/work/tickets/{ticketId}	Lire, mettre à jour ou archiver un ticket.
GET	/v1/work/me/dashboard	Renvoyer le résumé du tableauWork de bord « Work » actif.
GET	/v1/work/me/quota	Renvoyer l’utilisationWork et les limites actuelles de .
GET, POST	/v1/work/import/jobs	Répertorier ou gérer les tâches d’importation prises en charge.

Les tableaux, tickets, sprints, automatisations, importations, enregistrements de temps, commentaires, pièces jointes, vues enregistrées et appartenance à un espace de travail continuent d’appliquer leursWork rôles et autorisations d’accès aux ressources après la vérification de la portée de la passerelle.

Org Chart

L’interfaceOrg Chart est disponible sous /v1/charts. Les méthodes de lecture nécessitent charts:read, les méthodes de création et de mise à jour nécessitent charts:writeLes méthodes , et delete nécessitent charts:delete.

Les routes courantes comprennent :

Méthode	Parcours	Objectif
GET	/v1/charts/me/org-chart	Lire le graphique de l’utilisateur actif.
GET	/v1/charts/me/position	Lire la position active du graphique.
GET	/v1/charts/me/connections	Lire les connexions de relations.
GET	/v1/charts/me/suggestions	Consultez les suggestions de relations.
GET	/v1/charts/users/search	Recherchez des utilisateurs pour établir des relations entre les graphiques.
GET	/v1/charts/orgs/{orgId}/chart	Consultez un organigramme.
PATCH	/v1/charts/orgs/{orgId}/config	Mettez à jour la configuration du graphique.
POST	/v1/charts/orgs/{orgId}/chart/nodes	Créez un nœud de diagramme.
PATCH, DELETE	/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}	Mettez à jour ou supprimez un nœud.

Interfaces de service étendues

La passerelle expose également les préfixes de service versionnés suivants :

Préfixe	Portée de lecture	Portée d’écriture ou d’action	Portée de suppression
/v1/forms	forms:read	forms:write	—
/v1/invoice	invoice:read	invoice:write; les actions d’envoi ou d’émission utilisent invoice:send	invoice:delete
/v1/qa	qa:read	qa:write	—
/v1/business	business:read	business:manage	—
/v1/billing	billing:read	billing:manage	—

Ces préfixes préservent le suffixe de ressource pris en charge sous la passerelle tout en centralisant l’authentification, l’accès aux services, les portées, les limites de débit et le contexte d’audit. Privilégiez le service officiel SDKou une route explicitement mise en avant par le service plutôt que de deviner les chemins d’accès aux ressources à partir du trafic du navigateur.

La facturation est une interface du plan de contrôle. Elle reste soumise aux restrictions API Gatewayd’accès, aux limites de débit et aux périmètres de facturation, même lorsqu’une passerelle de service de destination empêcherait un utilisateur d’effectuer un paiement ou de passer à un niveau supérieur.

Webhooks

La gestion des webhooks utilise /v1/webhooks et webhooks:manage. Consultez le guide dédié Guide des webhooks pour l’enregistrement des points de terminaison, la vérification de la livraison signée, la protection contre la relecture et la rotation des secrets.

Maintenez vos intégrations à jour

• Utilisez GET /v1/version pour obtenir des informations sur la version de Gateway.
• Ignorez les champs de réponse supplémentaires que votre client ne comprend pas.
• Lisez les en-têtes de limite en temps réel plutôt que de coder en dur les valeurs du forfait.
• Utilisez l’ensemble de périmètres de privilèges le plus restreint.
• Suivez le site de documentation et les notes de miseSDK à jour lors de l’adoption d’une nouvelle route.