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.

Crear una clave

1. Abrir API Claves.
2. Elija un nombre que identifique la carga de trabajo y el entorno.
3. Seleccione únicamente los ámbitos de servicio que necesite 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.

Envíe la credencial

Authorization: Bearer YOUR_API_KEY

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

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.

Catálogo de ámbitos

Los siguientes ámbitos públicos se agrupan por servicio. El panel de control muestra los ámbitos disponibles actualmente para la cuenta.

Servicio	Lea o utilice	Escribir o gestionar
Identidad	users:read, api:read, cli:use	api:manage
Drive	drive:read	drive:write, drive:delete
Chat	chat:read	chat:write
Calendar	calendar:read	calendar:write
Contacts	contacts:read	contacts:write
Meet	meet:read	meet:write
Notes	notes:read	notes:write
Learn	courses:read	courses:write
CHAMPREP AI	ai:chat	ai:chat
Mail	mail:read	mail:write, mail:send
Work	work:read	work:write, work:delete
Invoice	invoice:read	invoice:write, invoice:send, invoice:delete
Empresa	business:read	business:manage
Facturación	billing:read	billing:manage
Org Chart	charts:read	charts:write, charts:delete
CHAMPREP QA	qa:read	qa:write
Forms	forms:read	forms:write
Webhooks	—	webhooks:manage

El ámbito comodín concede un amplio acceso y debe reservarse para integraciones administrativas estrechamente controladas. Un ámbito permite una categoría de acciones; no anula los permisos del plan, el rol, la organización ni los recursos.

Ciclo de vida de las claves

Rotar

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.

Revocar

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.

Revisión

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

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.