Guía de autenticación de Archbee CLI
Resumen de autenticación
La mayoría de los comandos de la API de Archbee CLI requieren:
- --api-key
- --doc-space-id
Ejemplo:
archbee search-docs --api-key YOUR_API_KEY --doc-space-id YOUR_SPACE_IDTipos de claves API
Claves API de espacio
Las claves API de espacio están limitadas a un único espacio de documentación.
Puede generarlas desde:
Space Settings → API keysClaves API de equipo
Las claves API de equipo comienzan con:
abteam_Los administradores del equipo pueden crearlas desde:
Settings → DeveloperLas claves API de equipo pueden acceder a múltiples espacios.
Cuándo --doc-space-id es obligatorio
La mayoría de los comandos requieren un valor de --doc-space-id incluso cuando se utiliza una clave API de equipo.
Ejemplo:
archbee get-doc --api-key abteam_xxx --doc-space-id SPACE_IDComandos que no requieren --doc-space-id
Estos comandos de nivel de equipo pueden ejecutarse utilizando solo una clave API de equipo:
- exportar
- display-rules
- create-space
- subir
- listar-archivos
- eliminar-archivo
- mover-archivo
- reemplazar archivo
Claves API de solo lectura
Las claves API de equipo de solo lectura no pueden modificar contenido.
Comandos como estos fallarán con claves de solo lectura:
- crear-documento
- delete-doc
- publicar-espacio
- update-space
Solución de problemas de autenticación
Clave API no válida
Verifique:
- La clave no ha expirado
- La clave pertenece al equipo o espacio correcto
- No hay espacios ni comillas adicionales en el comando
Errores de acceso al espacio
Asegúrese de que la clave API tenga permiso para acceder al espacio especificado.
Permiso de comando denegado
Utilice una clave de equipo con permisos de escritura para comandos que cambian datos.