Aller au contenu
Documentation

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.

ZonePréfixePortées
Identité et profil/v1/auth, /v1/usersusers:read et le contexte des identifiants
Recherche sur l’ensemble des services/v1/searchLa portée de lecture de chaque service recherché
Drive/v1/drivedrive:read, drive:write, drive:delete
Chat/v1/chatchat:read, chat:write
Calendar/v1/calendarcalendar:read, calendar:write
Contacts/v1/contactscontacts:read, contacts:write
Meet/v1/meetmeet:read, meet:write
Notes/v1/notesnotes:read, notes:write
Feuilles de calcul/v1/sheetssheets:read, sheets:write, sheets:share, sheets:delete, sheets:export
Docs/passthrough/docsdocs:read, docs:write, docs:share, docs:delete, docs:export
Learn/v1/learn, /v1/coursescourses:read, courses:write
CHAMPREP AI/v1/aiai:chat
Mail/v1/mailmail:read, mail:write, mail:send
Work/v1/workwork:read, work:write, work:delete
Org Chart/v1/chartscharts:read, charts:write, charts:delete
Forms/v1/formsforms:read, forms:write
Invoice/v1/invoiceinvoice:read, invoice:write, invoice:send, invoice:delete
CHAMPREP QA/v1/qaqa:read, qa:write
CHAMPREP Code/passthrough/codecode: portées, voir CHAMPREP Code
Ferme de runners/passthrough/runner-farmrunner_farm:read, runner_farm:write
CHAMPREP Business/v1/businessbusiness:read, business:manage
Facturation/v1/billingbilling:read, billing:manage
Webhooks/v1/webhookswebhooks: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.

MéthodeParcoursObjectif
GET/v1/versionAfficher les informations relatives à la version publique de Gateway.
GET/v1/auth/whoamiRenvoyer le contexte de l’utilisateur actif, du profil, des identifiants et du forfait.
GET/v1/auth/quotaAfficher la clé actuelle et l’instantané du quota de la passerelle.
GET/v1/users/meAfficher le profil de l’utilisateur actuel.
GET/v1/users/me/notificationsAfficher 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.

MéthodeParcoursPortéeObjectif
GET/v1/searchPar service, voir ci-dessousEffectuez une recherche sur tous les services accessibles avec ces identifiants, en un seul appel.
GET/v1/search/servicesAucunIndiquez 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ètrePar défautObjectif
qobligatoireLe terme de recherche.
limit5Nombre maximal de résultats par service, jusqu’à 20.
servicestoutListe séparée par des virgules, par exemple mail,drive. Cela permet de réduire le nombre de requêtes.
semanticfalseConfigurer true pour reclasser les résultats à l’aide de l’IA et obtenir une réponse concise. Cela utilise vos propres crédits 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 :

reasonSignification
AI_CREDITS_EXHAUSTEDVous avez utilisé tous vos crédits IA mensuels.
PLAN_NO_AIVotre forfait ne comprend pas le service IA.
AI_UNAVAILABLELe 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.

Fenêtre de terminal
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é.

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êteServices recherchésCoût
?q=roadmap avec un forfait comprenant les huit88
?q=roadmap&services=mail11
?q=roadmap avec un forfait comprenant uniquement Notes11

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.

MéthodeParcoursPortéeObjectif
GET/v1/drive/filesdrive:readRépertorier ou rechercher des fichiers. Utiliser la search Effectuer une requête si nécessaire.
GET/v1/drive/foldersdrive:readAfficher le contenu du dossier racine.
GET/v1/drive/folders/{folderId}drive:readAfficher le contenu d’un dossier.
GET/v1/drive/starreddrive:readAfficher la liste des éléments favoris.
GET/v1/drive/recentdrive:readAfficher la liste des éléments récents.
GET/v1/drive/shareddrive:readAfficher la liste des éléments partagés.
GET/v1/drive/quotadrive:readAfficher l’utilisation actuelle de l’espace de stockage et la capacité disponible.
POST/v1/drive/uploaddrive:writeCréer une destination de téléchargement.
POST/v1/drive/filesdrive:writeEnregistrer les métadonnées du fichier une fois le téléchargement terminé.
POST/v1/drive/downloaddrive:readCréez un lien de téléchargement à durée de vie limitée lié aux identifiants d’authentification de l’appelant.
GET/v1/drive/content/{token}drive:readTransmettez un lien émis par /v1/drive/download.
POST/v1/drive/foldersdrive:writeCréer un dossier.
POST/v1/drive/renamedrive:writeDéplacer ou renommer un élément.
POST/v1/drive/deletedrive:deleteSupprimer un ou plusieurs éléments.
DELETE/v1/drive/files/{fileId}drive:deleteSupprimer un fichier via la procédure héritée de suppression d’un élément unique.

Les téléchargements se déroulent en deux étapes : POST /v1/drive/download renvoie un url sur la passerelle qui ne fonctionne que pour la cléAPI ou la session qui l’a demandé, jusqu’à ce que expiresInSeconds expire. Récupérez-le avec le même Authorization en-tête ; le lien n’est pas utilisable seul.

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 CLIlorsque vous n’avez pas besoin de mettre en œuvre cette séquence vous-même.

MéthodeParcoursPortéeObjectif
GET/v1/chat/roomschat:readRépertorier les salles visibles par le profil actif.
GET/v1/chat/rooms/{roomId}chat:readConsulter une salle.
POST/v1/chat/roomschat:writeCréer une salle.
GET/v1/chat/rooms/{roomId}/messageschat:readRépertorier les messages de la salle.
POST/v1/chat/rooms/{roomId}/messageschat:writeEnvoyer un message à la salle.
GET/v1/chat/messages/searchchat:readRechercher des messages.
GET/v1/chat/unreadchat:readRenvoyer le nombre de messages non lus.
GET/v1/chat/favoriteschat:readRépertorier les messages favoris.
MéthodeParcoursPortéeObjectif
GET/v1/calendar/eventscalendar:readRépertorier les événements ; prend en charge startDate et endDate Requêtes.
GET/v1/calendar/events/{eventId}calendar:readConsulter un événement.
POST/v1/calendar/eventscalendar:writeCréer un événement.
PATCH/v1/calendar/events/{eventId}calendar:writeMettre à jour un événement.
DELETE/v1/calendar/events/{eventId}calendar:writeSupprimer un événement.
GET/v1/calendar/upcomingcalendar:readRépertorier les réunions à venir.
GET/v1/calendar/invitationscalendar:readRé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.

MéthodeParcoursPortéeObjectif
GET/v1/contactscontacts:readAfficher la liste des contacts.
GET/v1/contacts/searchcontacts:readRechercher des contacts à l’aide de q ou email.
GET/v1/contacts/favoritescontacts:readRépertorier les favoris.
GET/v1/contacts/labelscontacts:readAfficher la liste des étiquettes.
GET/v1/contacts/{contactId}contacts:readConsulter un contact.
POST/v1/contactscontacts:writeAjouter un contact.
PUT/v1/contacts/{contactId}contacts:writeMettre à jour les métadonnées d’un contact.
DELETE/v1/contacts/{contactId}contacts:writeSupprimer un contact.
MéthodeParcoursPortéeObjectif
GET/v1/meet/roomsmeet:readRépertorier les salles de réunion.
GET/v1/meet/rooms/{roomId}meet:readConsulter une salle.
POST/v1/meet/roomsmeet:writeCréer une salle.
GET/v1/meet/sessionsmeet:readRépertorier les sessions de réunion.
GET/v1/meet/sessions/{sessionId}/participantsmeet:readRépertorier les participants à la session.
GET/v1/meet/recordingsmeet:readRépertorier les enregistrements disponibles.
GET/v1/meet/transcriptionsmeet:readRépertorier les transcriptions.
GET/v1/meet/transcriptions/{sessionId}meet:readConsulter la transcription d’une session finale.
GET/v1/meet/usagemeet:readRenvoyer 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.

MéthodeParcoursPortéeObjectif
GET/v1/notesnotes:readRépertorier les notes.
GET/v1/notes/sharednotes:readRépertorier les notes partagées avec le profil actif.
GET/v1/notes/{noteId}notes:readConsulter une note.
POST/v1/notesnotes:writeCréer une note.
PATCH/v1/notes/{noteId}notes:writeMettre à jour une note.
DELETE/v1/notes/{noteId}notes:writeSupprimer une note.
POST/v1/notes/{noteId}/sharenotes:writePartager une note à l’aide des paramètres d’accès pris en charge.

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

MéthodeParcoursPortéeObjectif
GET/v1/learncourses:readAfficher la liste des cours disponibles.
GET/v1/learn/enrolled/mycourses:readRépertorier les inscriptions de l’utilisateur actif.
GET/v1/learn/{courseId}courses:readConsulter un cours.
GET/v1/learn/{courseId}/sectionscourses:readAfficher la liste des sections de cours.
POST/v1/learncourses:writeCréer un cours lorsque le rôle l’autorise.
PUT/v1/learn/{courseId}courses:writeMettre à 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.

MéthodeParcoursPortéeObjectif
POST/v1/ai/chatai:chatEnvoyer une invite ou une charge utile de conversation prise en charge.
GET/v1/ai/conversationsai:chatAfficher la liste des conversations enregistrées.
GET/v1/ai/conversations/{conversationId}ai:chatLire une conversation.
DELETE/v1/ai/conversations/{conversationId}ai:chatSupprimer une conversation.
GET/v1/ai/usageai:chatRenvoyer 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.

MéthodeParcoursPortéeObjectif
GET/v1/mail/accountsmail:readRépertorier les comptes de messagerie connectés.
GET/v1/mail/emailsmail:readRépertorier les messages.
GET/v1/mail/emails/{emailId}mail:readLire un message.
GET/v1/mail/threadsmail:readRépertorier les fils de discussion.
GET/v1/mail/threads/{threadId}mail:readLire un fil de discussion.
POST/v1/mail/sendmail:sendEnvoyer un message.
GET/v1/mail/domainsmail:readRépertorier les domaines de messagerie visibles.

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éthodeParcoursObjectif
GET, POST/v1/work/boardsRé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}/kanbanLire la vue Kanban du tableau.
GET/v1/work/boards/{boardId}/export/csvExporter un tableau au format CSV.
GET/v1/work/boards/{boardId}/export/jsonExporter un instantané structuré du tableau.
GET, POST/v1/work/ticketsRechercher ou créer des tickets.
GET, PUT, DELETE/v1/work/tickets/{ticketId}Lire, mettre à jour ou archiver un ticket.
GET/v1/work/me/dashboardRenvoyer le résumé du tableauWork de bord « Work » actif.
GET/v1/work/me/quotaRenvoyer l’utilisationWork et les limites actuelles de .
GET, POST/v1/work/import/jobsRé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.

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éthodeParcoursObjectif
GET/v1/charts/me/org-chartLire le graphique de l’utilisateur actif.
GET/v1/charts/me/positionLire la position active du graphique.
GET/v1/charts/me/connectionsLire les connexions de relations.
GET/v1/charts/me/suggestionsConsultez les suggestions de relations.
GET/v1/charts/users/searchRecherchez des utilisateurs pour établir des relations entre les graphiques.
GET/v1/charts/orgs/{orgId}/chartConsultez un organigramme.
PATCH/v1/charts/orgs/{orgId}/configMettez à jour la configuration du graphique.
POST/v1/charts/orgs/{orgId}/chart/nodesCréez un nœud de diagramme.
PATCH, DELETE/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}Mettez à jour ou supprimez un nœud.

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

PréfixePortée de lecturePortée d’écriture ou d’actionPortée de suppression
/v1/formsforms:readforms:write—
/v1/sheetssheets:read; les actions d’exportation utilisent sheets:exportsheets:write; le partage et la publication utilisent sheets:sharesheets:delete
/v1/invoiceinvoice:readinvoice:write; les actions d’envoi ou d’émission utilisent invoice:sendinvoice:delete
/v1/qaqa:readqa:write—
/v1/businessbusiness:readbusiness:manage—
/v1/billingbilling:readbilling: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 périmètres, les limites de débit et le contexte d’audit . Privilégiez 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.

CHAMPREP Code, la ferme de runners et Docs sont accessibles via un passage : la passerelle transmet votre requête à l’API REST propre à ce service sousAPI un chemin fixe, après avoir effectué les mêmes vérifications de clé, de limitation de débit, de forfait et de périmètre que pour tout autre itinéraire. Le chemin situé après le préfixe correspond au cheminAPI propre au service.

PréfixeTransfertsExemple
/passthrough/codeCHAMPREP APIChemins d’accès Code sous /v1/codeGET /passthrough/code/v1/code/projects
/passthrough/runner-farmCheminsAPI d’accès de la ferme de runners sous /v1GET /passthrough/runner-farm/v1/pools
/passthrough/docsCheminsAPI d’accès Docs sous /api/v1/docsGET /passthrough/docs/api/v1/docs/documents

Un chemin situé en dehors de l’espace de noms autorisé renvoie 404 NOT_FOUND. Seules les identifiants propres à la passerelle permettent d’accéder au service : n’envoyez pas de jetons de service dans les en-têtes ou dans job_token, private_token, ou access_token paramètres de requête , car la passerelle les supprime.

  • GET, HEAD, et OPTIONS nécessite au moins un code: portée autorisée à lire. Les autres méthodes nécessitent code:api ou un code:write_ portée.
  • CHAMPREP Code vérifie ensuite la portée exacte de chaque point de terminaison, de la même manière qu’il vérifie un jeton d’accès personnel. Par exemple, la lecture des fichiers du référentiel nécessite code:read_repository, code:read_api, ou code:api.
  • Les chemins d’accès sous /v1/code/admin nécessitent une clé associée à code:admin_mode par nom, ainsi qu’un compte disposant des droits d’administrateur Code. Les caractères génériques et code:api ne permettent pas d’y accéder.

  • Les méthodes de lecture nécessitent runner_farm:read. Les autres méthodes nécessitent runner_farm:write.
  • Une clé n’accède jamais aux secrets des connecteurs, aux jetons Runner, à la vérification des jetons, à l’appairage ou aux points de terminaison propres au connecteur, et elle n’achète jamais de crédits ni ne modifie les paramètres de paiement. Pour ces opérations, utilisez l’application « Runner Farm » après vous être connecté.
RequêtePortée
GET, HEADdocs:read
Un chemin d’accès gérant les autorisations, les liens de partage ou la publicationdocs:share
DELETE, ou un chemin se terminant par /purgedocs:delete
Un chemin se terminant par /exportdocs:export
Toute autre modificationdocs:write

La suppression d’une image dans un document est une modification ordinaire et nécessite docs:write.

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.

  • 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 les notes de mise à jour du site de documentation lorsque vous adoptez une nouvelle route.