Ir al contenido
Documentation

Referencia de puntos finales del servicio

Todas las rutas de esta página son relativas a:

https://api.champrep.com

Utilice una credencial de portador con ámbito limitado tal y como se describe en Autenticación y clavesAPI. Una ruta incluida en la lista sigue sujeta a la disponibilidad actual del servicio, la configuración del plan y de la organización, los permisos de los roles, el acceso a los recursos y los controles de uso en tiempo real.

ÁreaPrefijoÁmbitos de aplicación
Identidad y perfil/v1/auth, /v1/usersusers:read y contexto de credenciales
Busque en todos los servicios/v1/searchEl ámbito de lectura de cada servicio buscado
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
Hojas de cálculo/v1/sheetssheets:read, sheets:write, sheets:share, sheets:delete, sheets:export
Documentos/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: ámbitos, véase CHAMPREP Código
Granja de ejecutores/passthrough/runner-farmrunner_farm:read, runner_farm:write
CHAMPREP Business/v1/businessbusiness:read, business:manage
Facturación/v1/billingbilling:read, billing:manage
Webhooks/v1/webhookswebhooks:manage

GET, HEAD, y OPTIONS normalmente requieren el ámbito de lectura. Los métodos de creación, actualización y acción requieren el ámbito de escritura o de gestión. Los métodos de eliminación requieren un ámbito de eliminación cuando el servicio lo defina. Una ruta puede requerir permisos adicionales de rol o de recurso en el servicio de destino.

MétodoRutaObjetivo
GET/v1/versionMostrar la información de la versión pública de Gateway.
GET/v1/auth/whoamiMostrar el usuario activo, el perfil, las credenciales y el contexto del plan.
GET/v1/auth/quotaMostrar la instantánea actual de la cuota de la clave y de Gateway.
GET/v1/users/meMostrar el perfil del usuario actual.
GET/v1/users/me/notificationsMostrar las notificaciones visibles para el usuario actual.

El intercambioCLI asistido por el navegador también utiliza /v1/auth/cli/start, /v1/auth/cli/device, y /v1/auth/cli/poll. Estas rutas están implementadas por la aplicación oficialCLI; las aplicaciones personalizadas no deben imitar el protocolo de aprobaciónCLI cuando una claveAPI satisfaga sus necesidades.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/searchPor servicio, véase a continuaciónBusque en todos los servicios a los que puedan acceder estas credenciales, en una sola llamada.
GET/v1/search/servicesNingunaIndique en qué servicios puede realizar búsquedas esta credencial.

/v1/search se distribuye entre los servicios que admiten la búsqueda y fusiona los resultados. Parámetros:

ParámetroPor defectoObjetivo
qobligatorioEl término de búsqueda.
limit5Número máximo de resultados por servicio, hasta 20.
servicestodoLista separada por comas, por ejemplo mail,drive. De este modo, se reduce la dispersión.
semanticfalseConfigurar true para volver a clasificar los resultados con IA y obtener una respuesta breve. Consume sus propios créditos de IA.

semantic=true Añade una pasada de IA a los resultados que ya tiene: lee su pregunta, reordena los resultados según cómo responden a ella, añade una breve explicación a cada uno y devuelve un párrafo answer.

Se paga con sus propios créditos de IA — la misma asignación mensual que utiliza el CHAMPREP AIasistente. No se le cobrará nada a menos que lo solicite, y la búsqueda por palabra clave nunca consume créditos de IA.

Cada respuesta indica lo que ha ocurrido en semantic:

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

Cuando no se puede ejecutar la búsqueda con IA, se muestran los resultados de sus palabras clave sin cambios y semantic explica el motivo:

reasonSignificado
AI_CREDITS_EXHAUSTEDHa agotado sus créditos mensuales de IA.
PLAN_NO_AISu plan no incluye el servicio de IA.
AI_UNAVAILABLENo se ha podido acceder al servicio de IA en esta ocasión.

Un «paso de IA» fallido nunca hace que falle la búsqueda. Llame /v1/search/services primero para comprobar si la búsqueda inteligente está disponible — devuelve semantic.available además de sus créditos restantes — y oculte la opción de IA cuando no esté disponible.

Un servicio solo se incluye cuando la credencial tiene un ámbito de lectura (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) y si el plan activo lo permite. Ambas comprobaciones fallan en caso de no cumplir los requisitos, por lo que un servicio que no pueda utilizar nunca aportará resultados.

Chat Los mensajes se cifran en reposo y solo se buscan dentro de las salas a las que pertenece, en el historial reciente en lugar de en el archivo completo.

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

Los resultados se agrupan por servicio y se normalizan a un único formato, de modo que un cliente representa cada servicio de la misma manera:

{
"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
}
}

Leer skipped antes de considerar un resultado vacío como «no se ha encontrado nada». Cada entrada explica por qué se ha omitido un servicio — INSUFFICIENT_SCOPE, NOT_IN_PLAN, o SERVICE_UNAVAILABLE cuando un servidor de fondo era demasiado lento o estaba temporalmente inaccesible. Un servicio no disponible nunca hace que falle toda la consulta; el resto de los resultados siguen apareciendo.

Una búsqueda alcanza un servicio por cada grupo de resultados, por lo que se cobra de esa manera: una unidad de límite de rate por cada servicio realmente consultado. El cost El campo de cada respuesta le indica exactamente lo que se ha cobrado, y X-RateLimit-Remaining lo refleja antes de que reciba la respuesta.

SolicitudServicios consultadosCoste
?q=roadmap en un plan con los ocho88
?q=roadmap&services=mail11
?q=roadmap en un plan con solo Notes11

Nunca se le cobrará por un servicio que no pueda utilizar, por lo que filtrar con services es la forma más económica de mantener una búsqueda interactiva con buena capacidad de respuesta. Aplique siempre el «debounce»: nunca envíe una solicitud por cada pulsación de tecla.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/drive/filesdrive:readMostrar o buscar archivos. Utilice el search Realizar consultas cuando sea necesario.
GET/v1/drive/foldersdrive:readMostrar el contenido de la carpeta raíz.
GET/v1/drive/folders/{folderId}drive:readMostrar el contenido de una carpeta.
GET/v1/drive/starreddrive:readMostrar los elementos marcados con estrella.
GET/v1/drive/recentdrive:readMostrar los elementos recientes.
GET/v1/drive/shareddrive:readMostrar los elementos compartidos.
GET/v1/drive/quotadrive:readMostrar el uso actual del almacenamiento y la disponibilidad.
POST/v1/drive/uploaddrive:writeCrear un destino de carga.
POST/v1/drive/filesdrive:writeGuardar los metadatos del archivo una vez que la subida se haya realizado correctamente.
POST/v1/drive/downloaddrive:readCree un enlace de descarga de corta duración vinculado a la credencial de la llamada.
GET/v1/drive/content/{token}drive:readTransmita un enlace emitido por /v1/drive/download.
POST/v1/drive/foldersdrive:writeCrear una carpeta.
POST/v1/drive/renamedrive:writeMover o renombrar un elemento.
POST/v1/drive/deletedrive:deleteEliminar uno o varios elementos.
DELETE/v1/drive/files/{fileId}drive:deleteEliminar un archivo mediante el método heredado de eliminación de un solo elemento.

Las descargas se realizan en dos pasos: POST /v1/drive/download devuelve un url en la pasarela que solo funciona para la claveAPI o sesión que lo solicitó, hasta que expiresInSeconds expiren. Obténgalo con el mismo Authorization encabezado; el enlace no se puede utilizar por sí solo.

La carga es una operación de varios pasos: solicitar un destino de carga, transferir los bytes a dicho destino y guardar los metadatos resultantes. Utilice el CLIcuando no necesite implementar esa secuencia usted mismo.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/chat/roomschat:readMostrar una lista de salas visibles para el perfil activo.
GET/v1/chat/rooms/{roomId}chat:readConsultar una sala.
POST/v1/chat/roomschat:writeCrear una sala.
GET/v1/chat/rooms/{roomId}/messageschat:readMostrar los mensajes de la sala.
POST/v1/chat/rooms/{roomId}/messageschat:writeEnviar un mensaje a la sala.
GET/v1/chat/messages/searchchat:readBuscar mensajes.
GET/v1/chat/unreadchat:readMostrar el recuento de mensajes no leídos.
GET/v1/chat/favoriteschat:readMostrar los mensajes favoritos.
MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/calendar/eventscalendar:readListar eventos; admite startDate y endDate Consultas.
GET/v1/calendar/events/{eventId}calendar:readLeer un evento.
POST/v1/calendar/eventscalendar:writeCrear un evento.
PATCH/v1/calendar/events/{eventId}calendar:writeActualizar un evento.
DELETE/v1/calendar/events/{eventId}calendar:writeEliminar un evento.
GET/v1/calendar/upcomingcalendar:readMostrar las próximas reuniones.
GET/v1/calendar/invitationscalendar:readMostrar las invitaciones pendientes.

Envíe las marcas de tiempo de los eventos en formato ISO 8601 con una zona horaria explícita. La creación y actualización de eventos consumen la cuota configurada para el plan activo y la organización; el APIno define un límite fijo universal por plan.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/contactscontacts:readMostrar la lista de contactos.
GET/v1/contacts/searchcontacts:readBuscar contactos con q o email.
GET/v1/contacts/favoritescontacts:readMostrar favoritos.
GET/v1/contacts/labelscontacts:readMostrar una lista de etiquetas.
GET/v1/contacts/{contactId}contacts:readLeer un contacto.
POST/v1/contactscontacts:writeAñadir un contacto.
PUT/v1/contacts/{contactId}contacts:writeActualizar los metadatos de un contacto.
DELETE/v1/contacts/{contactId}contacts:writeEliminar un contacto.
MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/meet/roomsmeet:readMostrar una lista de salas de reuniones.
GET/v1/meet/rooms/{roomId}meet:readConsultar una sala.
POST/v1/meet/roomsmeet:writeCrear una sala.
GET/v1/meet/sessionsmeet:readMostrar una lista de sesiones de reuniones.
GET/v1/meet/sessions/{sessionId}/participantsmeet:readMostrar los participantes de la sesión.
GET/v1/meet/recordingsmeet:readMostrar las grabaciones disponibles.
GET/v1/meet/transcriptionsmeet:readMostrar las transcripciones.
GET/v1/meet/transcriptions/{sessionId}meet:readLeer la transcripción de una sesión final.
GET/v1/meet/usagemeet:readMostrar el uso actual de las reuniones.

El acceso a las grabaciones y transcripciones depende de la titularidad de la reunión, el consentimiento, el periodo de conservación, el plan y la política de la organización.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/notesnotes:readMostrar las notas.
GET/v1/notes/sharednotes:readMostrar las notas compartidas con el perfil activo.
GET/v1/notes/{noteId}notes:readLeer una nota.
POST/v1/notesnotes:writeCrear una nota.
PATCH/v1/notes/{noteId}notes:writeActualizar una nota.
DELETE/v1/notes/{noteId}notes:writeEliminar una nota.
POST/v1/notes/{noteId}/sharenotes:writeCompartir una nota utilizando la configuración de acceso compatible.

/v1/learn y /v1/courses Mostrar las mismas rutas de cursos seleccionadas.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/learncourses:readMostrar los cursos disponibles.
GET/v1/learn/enrolled/mycourses:readMostrar la lista de matrículas del usuario activo.
GET/v1/learn/{courseId}courses:readConsultar un curso.
GET/v1/learn/{courseId}/sectionscourses:readMostrar las secciones del curso.
POST/v1/learncourses:writeCrear un curso cuando el rol lo permita.
PUT/v1/learn/{courseId}courses:writeActualizar un curso cuando el rol lo permita.

Utilice el /v1/courses Utilice el prefijo en su lugar al mantener una integración que ya utilice ese alias.

MétodoRutaÁmbito de aplicaciónObjetivo
POST/v1/ai/chatai:chatEnviar una solicitud o una carga útil de conversación compatible.
GET/v1/ai/conversationsai:chatMostrar las conversaciones guardadas.
GET/v1/ai/conversations/{conversationId}ai:chatLeer una conversación.
DELETE/v1/ai/conversations/{conversationId}ai:chatEliminar una conversación.
GET/v1/ai/usageai:chatMostrar el uso actual de IA.

Los resultados generados por la IA pueden ser incompletos o incorrectos. Revise los resultados importantes y no envíe datos que el usuario activo no esté autorizado a divulgar.

MétodoRutaÁmbito de aplicaciónObjetivo
GET/v1/mail/accountsmail:readEnumerar las cuentas de correo electrónico conectadas.
GET/v1/mail/emailsmail:readEnumerar mensajes.
GET/v1/mail/emails/{emailId}mail:readLeer un mensaje.
GET/v1/mail/threadsmail:readEnumerar hilos.
GET/v1/mail/threads/{threadId}mail:readLeer un hilo.
POST/v1/mail/sendmail:sendEnviar un mensaje.
GET/v1/mail/domainsmail:readMostrar una lista de los dominios de correo visibles.

La interfaz Work«Gateway» refleja la versión compatible de que se encuentra debajoWorkAPI de /v1/work. La pasarela determina el ámbito requerido a partir del método HTTP:

  • Los métodos de lectura requieren work:read.
  • Los métodos «create» y «update» requieren work:write.
  • Los métodos de eliminación y las acciones destructivas masivas o de cancelación de importaciones requieren work:delete.

Las rutas habituales incluyen:

MétodoRutaObjetivo
GET, POST/v1/work/boardsEnumerar o crear tableros.
GET, PUT, DELETE/v1/work/boards/{boardId}Leer, actualizar o archivar un tablero.
GET/v1/work/boards/{boardId}/kanbanLeer la vista Kanban del tablero.
GET/v1/work/boards/{boardId}/export/csvExportar un tablero como CSV.
GET/v1/work/boards/{boardId}/export/jsonExportar una instantánea estructurada del tablero.
GET, POST/v1/work/ticketsBuscar o crear tickets.
GET, PUT, DELETE/v1/work/tickets/{ticketId}Leer, actualizar o archivar un ticket.
GET/v1/work/me/dashboardMostrar el resumen del panelWork de control de «Work» activo.
GET/v1/work/me/quotaMostrar el usoWork y los límites actuales de .
GET, POST/v1/work/import/jobsEnumerar o gestionar las tareas de importación compatibles.

Los tableros, tickets, sprints, automatizaciones, importaciones, registros de tiempo, comentarios, archivos adjuntos, vistas guardadas y pertenencia al espacio de trabajo siguen aplicando susWork roles y permisos de recursos tras la comprobación del ámbito de Gateway.

La superficieOrg Chart está disponible debajo de /v1/charts. Los métodos de lectura requieren charts:read, los métodos de creación y actualización requieren charts:writeLos métodos y de eliminación requieren charts:delete.

Las rutas habituales incluyen:

MétodoRutaObjetivo
GET/v1/charts/me/org-chartLea el gráfico del usuario activo.
GET/v1/charts/me/positionLea la posición activa del gráfico.
GET/v1/charts/me/connectionsLea las conexiones de relaciones.
GET/v1/charts/me/suggestionsLea las sugerencias de relaciones.
GET/v1/charts/users/searchBusque usuarios para establecer relaciones en el gráfico.
GET/v1/charts/orgs/{orgId}/chartLea un organigrama.
PATCH/v1/charts/orgs/{orgId}/configActualice la configuración del gráfico.
POST/v1/charts/orgs/{orgId}/chart/nodesCree un nodo de gráfico.
PATCH, DELETE/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}Actualice o elimine un nodo.

La pasarela también expone los siguientes prefijos de servicio versionados:

PrefijoÁmbito de lecturaÁmbito de escritura o de acciónÁmbito de eliminación
/v1/formsforms:readforms:write—
/v1/sheetssheets:read; las acciones de exportación utilizan sheets:exportsheets:write; el uso compartido y la publicación utilizan sheets:sharesheets:delete
/v1/invoiceinvoice:readinvoice:write; las acciones de envío o emisión utilizan invoice:sendinvoice:delete
/v1/qaqa:readqa:write—
/v1/businessbusiness:readbusiness:manage—
/v1/billingbilling:readbilling:manage—

Estos prefijos conservan el sufijo de recurso compatible bajo la pasarela, al tiempo que centralizan la autenticación, el acceso al servicio, los ámbitos, los límites de tasa y el contexto de auditoría . Es preferible utilizar una ruta expuesta explícitamente por el servicio en lugar de deducir las rutas de los recursos a partir del tráfico del navegador.

La facturación es una interfaz del plano de control. Sigue estando sujeta a API Gatewayacceso, límites de tasa y ámbitos de facturación, incluso cuando una puerta de enlace del servicio de destino impida a un usuario realizar el pago o actualizar su plan.

CHAMPREP Se accede a Code, la granja de ejecutores y Docs a través de un paso directo: la puerta de enlace reenvía su solicitud al propio REST de ese servicio APIbajo una ruta fija, tras las mismas comprobaciones de clave, límite de tasa, plan y ámbito que cualquier otra ruta. La ruta que sigue al prefijo es la propia APIruta del servicio.

PrefijoReenvíosEjemplo
/passthrough/codeCHAMPREP RutasAPI de Code bajo /v1/codeGET /passthrough/code/v1/code/projects
/passthrough/runner-farmRutasAPI de la granja de ejecutores bajo /v1GET /passthrough/runner-farm/v1/pools
/passthrough/docsAPIRutas de Docs bajo /api/v1/docsGET /passthrough/docs/api/v1/docs/documents

Una ruta fuera del espacio de nombres permitido devuelve 404 NOT_FOUND. Solo las credenciales propias de Gateway tienen acceso al servicio: no envíe tokens de servicio en encabezados ni en job_token, private_token, o access_token parámetros de consulta, ya que la pasarela los elimina.

  • GET, HEAD, y OPTIONS Se necesita al menos un code: ámbito con permiso de lectura. Otros métodos requieren code:api o una code:write_ ámbito.
  • CHAMPREP A continuación, Code comprueba el ámbito exacto de cada punto final, del mismo modo que comprueba un token de acceso personal. Por ejemplo, para leer archivos del repositorio se necesita code:read_repository, code:read_api, o code:api.
  • Las rutas bajo /v1/code/admin necesitan una clave que contenga code:admin_mode por nombre y una cuenta que sea administradora de Code. Los comodines y code:api no les dan acceso.

  • Los métodos de lectura requieren runner_farm:read. Otros métodos requieren runner_farm:write.
  • Una clave nunca tiene acceso a los secretos de los conectores, a los tokens de los runners, a la verificación de tokens, al emparejamiento ni a los propios puntos de conexión del conector, y nunca compra créditos ni modifica la configuración de pago. Para ello, utilice la aplicación «Granja de runners» tras haber iniciado sesión.

SolicitudÁmbito de aplicación
GET, HEADdocs:read
Una ruta que gestione autorizaciones, enlaces para compartir o publicacionesdocs:share
DELETE, o una ruta que termine en /purgedocs:delete
Una ruta que termine en /exportdocs:export
Cualquier otro cambiodocs:write

La eliminación de una imagen dentro de un documento es una edición ordinaria y requiere docs:write.

La gestión de webhooks utiliza /v1/webhooks y webhooks:manage. Consulte la guía específica Guía de webhooks para el registro de puntos finales, la verificación de entrega firmada, la protección contra repetición y la rotación de claves secretas.

  • Utilice GET /v1/version para obtener información sobre la versión de Gateway.
  • Ignore los campos de respuesta adicionales que su cliente no comprenda.
  • Lea los encabezados de límites en tiempo real en lugar de codificar de forma fija los valores del plan.
  • Utilice el conjunto de ámbitos de privilegios mínimos.
  • Siga las notas de la versión del sitio de documentación al adoptar una nueva ruta.