Ir al contenido
Documentation

Autenticación y clavesAPI

El aceptaAPI Gateway clavesCHAMPREPAPI con ámbito para integraciones de servidor y automatización. Las sesiones de cuenta basadas en navegador se utilizan para gestionar claves, pero una integración personalizada debe autenticar sus solicitudes de servicio con una claveAPI.

  1. Abrir API Claves.
  2. Elija un nombre que identifique la carga de trabajo y el entorno.
  3. Para cada servicio, elija un nivel de acceso y, a continuación, limítelo únicamente a los ámbitos que requiera la carga de trabajo.
  4. Añada una lista de direcciones IP permitidas cuando la carga de trabajo cuente con direcciones de salida estables.
  5. Copie la clave una vez y guárdela en un gestor de secretos o en el llavero.

No cree una única clave de ámbito amplio para todas las aplicaciones. Las claves independientes hacen que la rotación, la revisión de auditoría y la respuesta ante incidentes sean más seguras.

Authorization: Bearer YOUR_API_KEY

Para ver ejemplos de shell, guarde el valor en una variable de entorno:

Ventana de terminal
curl --fail-with-body \
--header "Authorization: Bearer $CHAMPREP_TOKEN" \
https://api.champrep.com/v1/auth/whoami

No incluya una clave en una URL, un parámetro de consulta, un paquete de JavaScript de front-end, una aplicación móvil, una línea de registro ni un evento de análisis.

La pantalla API«Claves» agrupa los servicios en cuatro áreas: Espacio de trabajo, Comunicación, Desarrollador y Administración. Para cada servicio, elija un nivel de acceso y, a continuación, añada o elimine ámbitos concretos si la carga de trabajo requiere un acceso más restringido:

  • Ninguna: la clave no puede utilizar el servicio.
  • Lectura: los ámbitos de la columna «Lectura».
  • Lectura y escritura: Lectura más los ámbitos de la columna «Escritura».
  • Administrador: todo lo anterior más los ámbitos de la columna «Admin», para los servicios que dispongan de ellos.

Ámbitos marcados inscripción voluntaria nunca se seleccionan por nivel. Márquelas por su nombre. Un servicio que no esté incluido en su plan aparecerá bloqueado, con un enlace para actualizar. La pantalla muestra siempre el catálogo que está activo en ese momento.

ServicioLecturaEscrituraAdministrador
Drivedrive:readdrive:write, drive:delete—
Documentosdocs:read, docs:exportdocs:write, docs:share, docs:delete—
Hojas de cálculosheets:read, sheets:exportsheets:write, sheets:share, sheets:delete—
Notesnotes:readnotes:write—
Calendarcalendar:readcalendar:write—
Contactscontacts:readcontacts:write—
Workwork:readwork:write, work:delete—
Formsforms:readforms:write—
Invoiceinvoice:readinvoice:write, invoice:send, invoice:delete—
Organigramascharts:readcharts:write, charts:delete—
Learncourses:readcourses:write—
Escuela LMSAún no disponible mediante claveAPI

ServicioLecturaEscrituraAdministrador
Mailmail:readmail:write, mail:send—
Chatchat:readchat:write—
Meetmeet:readmeet:write—
RTCPróximamente. RTC utiliza sus propias clavesAPI de proyecto

ServicioLecturaEscrituraAdministrador
CHAMPREP Codecode:read_api, code:read_repository, code:read_registry, code:read_package_registrycode:write_repository, code:write_registry, code:write_package_registrycode:api; participación voluntaria code:admin_mode
CHAMPREP QAqa:readqa:write—
Granja de ejecutoresrunner_farm:readrunner_farm:write—
CLI—cli:use—
CHAMPREP AI—ai:chat; participación voluntaria ai:actions, ai:agent—

ServicioLecturaEscrituraAdministrador
Empresabusiness:read—business:manage
Facturaciónbilling:read—billing:manage
Desarrollador APIapi:read—api:manage, webhooks:manage
Perfilusers:read——

La administración de la plataforma nunca está disponible para una claveAPI; requiere un administrador que haya iniciado sesión.

  • CHAMPREP Código. Cada code: El ámbito coincide con el ámbito del token de acceso personal del mismo nombre en CHAMPREPCode, y Code lo comprueba en cada punto final. code:api supone un acceso completo de lectura y escritura a todo aquello a lo que su cuenta pueda acceder en Code, por lo que se sitúa en el nivel de administrador; es preferible utilizar el más restringido read_ y write_ . Los puntos finales de administración de Code necesitan una clave que contenga code:admin_mode por nombre, y una cuenta que sea administradora de Code.
  • Granja de ejecutores. runner_farm:write registra y gestiona los runners, los grupos y las conexiones. Nunca adquiere créditos ni modifica la configuración de pago, y nunca emite, sustituye ni comprueba un secreto de conector o un token de runner. Para dichas acciones es necesario que una persona haya iniciado sesión.
  • Documentos y Hojas de cálculo. El uso compartido (colaboradores, uso compartido de enlaces, publicación), la eliminación permanente o el borrado, y la exportación requieren cada uno su propio ámbito. Una clave con únicamente docs:write o sheets:write pueden editar el contenido, pero no pueden compartirlo, eliminarlo ni exportarlo.
  • CHAMPREP AI. ai:agent permiten que el CLI Agente de IA utilizan herramientas locales e incluyen ai:chat. ai:actions aprueban o rechazan las acciones que la IA propone en sus CHAMPREPservicios, y nada más.

El ámbito comodín * (acceso completo) abarcan todos los servicios que incluye su plan, incluidos CHAMPREPCode, Runner Farm y Docs. CHAMPREPCode lo trata como code:api, lo que supone un acceso completo de lectura y escritura. No incluye ai:agent o code:admin_mode; estos deben seleccionarse siempre por su nombre.

Reserve el comodín para integraciones administrativas estrictamente controladas y limite las claves de acceso completo existentes si no necesitan los servicios más recientes. Un ámbito permite una categoría de acción; no anula los permisos de plan, rol, organización o recurso.

Cree o vuelva a generar una clave de sustitución, impleméntela, confirme que la carga de trabajo la está utilizando y, a continuación, revoque la clave anterior. Evite una rotación que deje una carga de trabajo desatendida sin credenciales válidas.

Revoque una clave inmediatamente si queda expuesta, se copia en un sistema no fiable o ya no pertenece a una carga de trabajo activa. Una clave revocada debe devolver 401 y no debe reintentarse indefinidamente.

Revise periódicamente los nombres de las claves, los ámbitos, las restricciones de IP, la información sobre el último uso y la actividad de auditoría. Elimine las claves que no se utilicen en lugar de conservarlas para un posible script futuro.

Inicio de sesión mediante navegador e CLIinicio de sesión

Sección titulada «Inicio de sesión mediante navegador e CLIinicio de sesión»

champrep auth login Utiliza un flujo de aprobación mediante navegador para una persona que se encuentra en un terminal. champrep auth token Almacena una APIclave con ámbito para la automatización. La CLI protegeCLI las credenciales almacenadas mediante el llavero del sistema operativo y envía todos los comandos de red a través de la puerta de enlace.

Véase CLI Autenticación y API Claves para la CLIautomatización para dichos flujos de trabajo.