Referencia de puntos finales del servicio
Todas las rutas de esta página son relativas a:
https://api.champrep.comUtilice 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.
Mapa de servicios
Sección titulada «Mapa de servicios»| Área | Prefijo | Ámbitos de aplicación |
|---|---|---|
| Identidad y perfil | /v1/auth, /v1/users | users:read y contexto de credenciales |
| Busque en todos los servicios | /v1/search | El ámbito de lectura de cada servicio buscado |
| 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 |
| Hojas de cálculo | /v1/sheets | sheets:read, sheets:write, sheets:share, sheets:delete, sheets:export |
| Documentos | /passthrough/docs | docs:read, docs:write, docs:share, docs:delete, docs:export |
| Learn | /v1/learn, /v1/courses | courses:read, courses:write |
| CHAMPREP AI | /v1/ai | ai:chat |
/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 Code | /passthrough/code | code: ámbitos, véase CHAMPREP Código |
| Granja de ejecutores | /passthrough/runner-farm | runner_farm:read, runner_farm:write |
| CHAMPREP Business | /v1/business | business:read, business:manage |
| Facturación | /v1/billing | billing:read, billing:manage |
| Webhooks | /v1/webhooks | webhooks: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.
Estado de la identidad y de la pasarela
Sección titulada «Estado de la identidad y de la pasarela»| Método | Ruta | Objetivo |
|---|---|---|
GET | /v1/version | Mostrar la información de la versión pública de Gateway. |
GET | /v1/auth/whoami | Mostrar el usuario activo, el perfil, las credenciales y el contexto del plan. |
GET | /v1/auth/quota | Mostrar la instantánea actual de la cuota de la clave y de Gateway. |
GET | /v1/users/me | Mostrar el perfil del usuario actual. |
GET | /v1/users/me/notifications | Mostrar 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.
Busque en todos los servicios
Sección titulada «Busque en todos los servicios»| Método | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/search | Por servicio, véase a continuación | Busque en todos los servicios a los que puedan acceder estas credenciales, en una sola llamada. |
GET | /v1/search/services | Ninguna | Indique 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ámetro | Por defecto | Objetivo |
|---|---|---|
q | obligatorio | El término de búsqueda. |
limit | 5 | Número máximo de resultados por servicio, hasta 20. |
services | todo | Lista separada por comas, por ejemplo mail,drive. De este modo, se reduce la dispersión. |
semantic | false | Configurar true para volver a clasificar los resultados con IA y obtener una respuesta breve. Consume sus propios créditos de IA. |
Búsqueda inteligente con IA
Sección titulada «Búsqueda inteligente con 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:
reason | Significado |
|---|---|
AI_CREDITS_EXHAUSTED | Ha agotado sus créditos mensuales de IA. |
PLAN_NO_AI | Su plan no incluye el servicio de IA. |
AI_UNAVAILABLE | No 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.
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.
Cuánto cuesta una búsqueda
Sección titulada «Cuánto cuesta una búsqueda»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.
| Solicitud | Servicios consultados | Coste |
|---|---|---|
?q=roadmap en un plan con los ocho | 8 | 8 |
?q=roadmap&services=mail | 1 | 1 |
?q=roadmap en un plan con solo Notes | 1 | 1 |
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étodo | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/drive/files | drive:read | Mostrar o buscar archivos. Utilice el search Realizar consultas cuando sea necesario. |
GET | /v1/drive/folders | drive:read | Mostrar el contenido de la carpeta raíz. |
GET | /v1/drive/folders/{folderId} | drive:read | Mostrar el contenido de una carpeta. |
GET | /v1/drive/starred | drive:read | Mostrar los elementos marcados con estrella. |
GET | /v1/drive/recent | drive:read | Mostrar los elementos recientes. |
GET | /v1/drive/shared | drive:read | Mostrar los elementos compartidos. |
GET | /v1/drive/quota | drive:read | Mostrar el uso actual del almacenamiento y la disponibilidad. |
POST | /v1/drive/upload | drive:write | Crear un destino de carga. |
POST | /v1/drive/files | drive:write | Guardar los metadatos del archivo una vez que la subida se haya realizado correctamente. |
POST | /v1/drive/download | drive:read | Cree un enlace de descarga de corta duración vinculado a la credencial de la llamada. |
GET | /v1/drive/content/{token} | drive:read | Transmita un enlace emitido por /v1/drive/download. |
POST | /v1/drive/folders | drive:write | Crear una carpeta. |
POST | /v1/drive/rename | drive:write | Mover o renombrar un elemento. |
POST | /v1/drive/delete | drive:delete | Eliminar uno o varios elementos. |
DELETE | /v1/drive/files/{fileId} | drive:delete | Eliminar 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étodo | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/chat/rooms | chat:read | Mostrar una lista de salas visibles para el perfil activo. |
GET | /v1/chat/rooms/{roomId} | chat:read | Consultar una sala. |
POST | /v1/chat/rooms | chat:write | Crear una sala. |
GET | /v1/chat/rooms/{roomId}/messages | chat:read | Mostrar los mensajes de la sala. |
POST | /v1/chat/rooms/{roomId}/messages | chat:write | Enviar un mensaje a la sala. |
GET | /v1/chat/messages/search | chat:read | Buscar mensajes. |
GET | /v1/chat/unread | chat:read | Mostrar el recuento de mensajes no leídos. |
GET | /v1/chat/favorites | chat:read | Mostrar los mensajes favoritos. |
Calendar
Sección titulada «Calendar»| Método | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/calendar/events | calendar:read | Listar eventos; admite startDate y endDate Consultas. |
GET | /v1/calendar/events/{eventId} | calendar:read | Leer un evento. |
POST | /v1/calendar/events | calendar:write | Crear un evento. |
PATCH | /v1/calendar/events/{eventId} | calendar:write | Actualizar un evento. |
DELETE | /v1/calendar/events/{eventId} | calendar:write | Eliminar un evento. |
GET | /v1/calendar/upcoming | calendar:read | Mostrar las próximas reuniones. |
GET | /v1/calendar/invitations | calendar:read | Mostrar 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.
Contacts
Sección titulada «Contacts»| Método | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/contacts | contacts:read | Mostrar la lista de contactos. |
GET | /v1/contacts/search | contacts:read | Buscar contactos con q o email. |
GET | /v1/contacts/favorites | contacts:read | Mostrar favoritos. |
GET | /v1/contacts/labels | contacts:read | Mostrar una lista de etiquetas. |
GET | /v1/contacts/{contactId} | contacts:read | Leer un contacto. |
POST | /v1/contacts | contacts:write | Añadir un contacto. |
PUT | /v1/contacts/{contactId} | contacts:write | Actualizar los metadatos de un contacto. |
DELETE | /v1/contacts/{contactId} | contacts:write | Eliminar un contacto. |
| Método | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/meet/rooms | meet:read | Mostrar una lista de salas de reuniones. |
GET | /v1/meet/rooms/{roomId} | meet:read | Consultar una sala. |
POST | /v1/meet/rooms | meet:write | Crear una sala. |
GET | /v1/meet/sessions | meet:read | Mostrar una lista de sesiones de reuniones. |
GET | /v1/meet/sessions/{sessionId}/participants | meet:read | Mostrar los participantes de la sesión. |
GET | /v1/meet/recordings | meet:read | Mostrar las grabaciones disponibles. |
GET | /v1/meet/transcriptions | meet:read | Mostrar las transcripciones. |
GET | /v1/meet/transcriptions/{sessionId} | meet:read | Leer la transcripción de una sesión final. |
GET | /v1/meet/usage | meet:read | Mostrar 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étodo | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/notes | notes:read | Mostrar las notas. |
GET | /v1/notes/shared | notes:read | Mostrar las notas compartidas con el perfil activo. |
GET | /v1/notes/{noteId} | notes:read | Leer una nota. |
POST | /v1/notes | notes:write | Crear una nota. |
PATCH | /v1/notes/{noteId} | notes:write | Actualizar una nota. |
DELETE | /v1/notes/{noteId} | notes:write | Eliminar una nota. |
POST | /v1/notes/{noteId}/share | notes:write | Compartir una nota utilizando la configuración de acceso compatible. |
Learn y cursos
Sección titulada «Learn y cursos»/v1/learn y /v1/courses Mostrar las mismas rutas de cursos seleccionadas.
| Método | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/learn | courses:read | Mostrar los cursos disponibles. |
GET | /v1/learn/enrolled/my | courses:read | Mostrar la lista de matrículas del usuario activo. |
GET | /v1/learn/{courseId} | courses:read | Consultar un curso. |
GET | /v1/learn/{courseId}/sections | courses:read | Mostrar las secciones del curso. |
POST | /v1/learn | courses:write | Crear un curso cuando el rol lo permita. |
PUT | /v1/learn/{courseId} | courses:write | Actualizar 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.
CHAMPREP AI
Sección titulada «CHAMPREP AI»| Método | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
POST | /v1/ai/chat | ai:chat | Enviar una solicitud o una carga útil de conversación compatible. |
GET | /v1/ai/conversations | ai:chat | Mostrar las conversaciones guardadas. |
GET | /v1/ai/conversations/{conversationId} | ai:chat | Leer una conversación. |
DELETE | /v1/ai/conversations/{conversationId} | ai:chat | Eliminar una conversación. |
GET | /v1/ai/usage | ai:chat | Mostrar 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étodo | Ruta | Ámbito de aplicación | Objetivo |
|---|---|---|---|
GET | /v1/mail/accounts | mail:read | Enumerar las cuentas de correo electrónico conectadas. |
GET | /v1/mail/emails | mail:read | Enumerar mensajes. |
GET | /v1/mail/emails/{emailId} | mail:read | Leer un mensaje. |
GET | /v1/mail/threads | mail:read | Enumerar hilos. |
GET | /v1/mail/threads/{threadId} | mail:read | Leer un hilo. |
POST | /v1/mail/send | mail:send | Enviar un mensaje. |
GET | /v1/mail/domains | mail:read | Mostrar 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étodo | Ruta | Objetivo |
|---|---|---|
GET, POST | /v1/work/boards | Enumerar o crear tableros. |
GET, PUT, DELETE | /v1/work/boards/{boardId} | Leer, actualizar o archivar un tablero. |
GET | /v1/work/boards/{boardId}/kanban | Leer la vista Kanban del tablero. |
GET | /v1/work/boards/{boardId}/export/csv | Exportar un tablero como CSV. |
GET | /v1/work/boards/{boardId}/export/json | Exportar una instantánea estructurada del tablero. |
GET, POST | /v1/work/tickets | Buscar o crear tickets. |
GET, PUT, DELETE | /v1/work/tickets/{ticketId} | Leer, actualizar o archivar un ticket. |
GET | /v1/work/me/dashboard | Mostrar el resumen del panelWork de control de «Work» activo. |
GET | /v1/work/me/quota | Mostrar el usoWork y los límites actuales de . |
GET, POST | /v1/work/import/jobs | Enumerar 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.
Org Chart
Sección titulada «Org Chart»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étodo | Ruta | Objetivo |
|---|---|---|
GET | /v1/charts/me/org-chart | Lea el gráfico del usuario activo. |
GET | /v1/charts/me/position | Lea la posición activa del gráfico. |
GET | /v1/charts/me/connections | Lea las conexiones de relaciones. |
GET | /v1/charts/me/suggestions | Lea las sugerencias de relaciones. |
GET | /v1/charts/users/search | Busque usuarios para establecer relaciones en el gráfico. |
GET | /v1/charts/orgs/{orgId}/chart | Lea un organigrama. |
PATCH | /v1/charts/orgs/{orgId}/config | Actualice la configuración del gráfico. |
POST | /v1/charts/orgs/{orgId}/chart/nodes | Cree un nodo de gráfico. |
PATCH, DELETE | /v1/charts/orgs/{orgId}/chart/nodes/{nodeId} | Actualice o elimine un nodo. |
Superficies de servicio ampliadas
Sección titulada «Superficies de servicio ampliadas»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/forms | forms:read | forms:write | — |
/v1/sheets | sheets:read; las acciones de exportación utilizan sheets:export | sheets:write; el uso compartido y la publicación utilizan sheets:share | sheets:delete |
/v1/invoice | invoice:read | invoice:write; las acciones de envío o emisión utilizan invoice:send | invoice:delete |
/v1/qa | qa:read | qa:write | — |
/v1/business | business:read | business:manage | — |
/v1/billing | billing:read | billing: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.
APIPasos de la API del servicio
Sección titulada «APIPasos de la API del servicio»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.
| Prefijo | Reenvíos | Ejemplo |
|---|---|---|
/passthrough/code | CHAMPREP RutasAPI de Code bajo /v1/code | GET /passthrough/code/v1/code/projects |
/passthrough/runner-farm | RutasAPI de la granja de ejecutores bajo /v1 | GET /passthrough/runner-farm/v1/pools |
/passthrough/docs | APIRutas de Docs bajo /api/v1/docs | GET /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.
CHAMPREP Code
Sección titulada «CHAMPREP Code»GET,HEAD, yOPTIONSSe necesita al menos uncode:ámbito con permiso de lectura. Otros métodos requierencode:apio unacode: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, ocode:api. - Las rutas bajo
/v1/code/adminnecesitan una clave que contengacode:admin_modepor nombre y una cuenta que sea administradora de Code. Los comodines ycode:apino les dan acceso.
Granja de ejecutores
Sección titulada «Granja de ejecutores»- Los métodos de lectura requieren
runner_farm:read. Otros métodos requierenrunner_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.
Documentos
Sección titulada «Documentos»| Solicitud | Ámbito de aplicación |
|---|---|
GET, HEAD | docs:read |
| Una ruta que gestione autorizaciones, enlaces para compartir o publicaciones | docs:share |
DELETE, o una ruta que termine en /purge | docs:delete |
Una ruta que termine en /export | docs:export |
| Cualquier otro cambio | docs:write |
La eliminación de una imagen dentro de un documento es una edición ordinaria y requiere
docs:write.
Webhooks
Sección titulada «Webhooks»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.
Mantenga las integraciones actualizadas
Sección titulada «Mantenga las integraciones actualizadas»- Utilice
GET /v1/versionpara 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.