Volver

Crea claves API para el Factorial IT API

Una Factorial IT API key autentica las llamadas que realizas a la Factorial IT API, una API REST. Crea una cuando quieras que una integración o script lea o cambie tus datos a través de la API.


 

Funcionalidad

Descripción general

Las claves autentican las solicitudes a la Factorial IT API (REST). Hay dos tipos, cada una con su propio alcance:

  • Clave API de la empresa. Limitada a una empresa. Abre cada endpoint que trabaja con recursos a nivel de empresa: dispositivos, empleados/as, accesorios, tickets, SaaS y más.
  • Clave API del espacio de trabajo. Cubre todo tu espacio de trabajo. Abre los endpoints a nivel de espacio de trabajo, por ejemplo, listar y ver las empresas en tu espacio de trabajo.

La mayoría de los endpoints necesitan una Clave API de la empresa. Solo los endpoints del espacio de trabajo (bajo /workspace/) necesitan una Clave API del espacio de trabajo. La referencia de la API muestra una insignia en cada endpoint con el tipo que espera.

 

Cómo usar: crear una clave API de la empresa

  1. Ve a Configuración > Desarrolladores.
  2. Haz clic en Crear clave.
  3. Escribe un Nombre de clave de 4 caracteres o más, por ejemplo "Mi integración".
  4. Establece el Nivel de acceso en Solo lectura o Lectura/escritura.
  5. Si lo deseas, establece una Expiración (días). Déjalo en blanco para una clave que nunca expira.
  6. Haz clic en Crear clave, luego en Copiar secreto. El secreto solo se muestra una vez.

Guarda la clave en un lugar seguro. Cualquiera que la tenga puede acceder a tus datos a través de la API.

 

Usar la clave

Envía la clave en el encabezado Authorization de cada solicitud:

curl https://api.getFactorial IT.com/v1/devices \
  -H "Authorization: Bearer YOUR_API_KEY"

 

Revocar una clave

  1. Ve a Configuración > Desarrolladores y encuentra la clave bajo Factorial IT API keys.
  2. Abre el menú ⋯ en su fila y haz clic en Revocar.
  3. Confirma.

La clave deja de funcionar de inmediato y no puede ser recuperada. Las claves revocadas permanecen en la lista para que puedas rastrearlas. Para eliminar una de forma permanente, abre su menú ⋯ y haz clic en Eliminar.

 

Ver registros de la API

Después de que tu empresa haya enviado su primera solicitud, una tarjeta de Ver registros de la API aparece en la pestaña de Desarrolladores. Haz clic en ella para abrir los registros de la API. La página lista las últimas 50 solicitudes REST y MCP para tu empresa. La columna Actor muestra la clave, cliente MCP o empleado/a detrás de cada una.


 

Consejos y mejores prácticas

  • Elige Solo lectura a menos que la integración deba escribir. Dale a cada clave el nivel de acceso más bajo que funcione.
  • Establece una expiración para integraciones temporales. Una clave que nunca expira sigue siendo un riesgo hasta que alguien la revoca.
  • Copiar el secreto de inmediato. No se muestra nuevamente.
  • Usa una clave por integración. Un nombre claro te dice qué deja de funcionar cuando la revocas.
  • Revisa los registros de la API. La columna Actor muestra quién está llamando a la API.

 

Solución de problemas y FAQ

Solución de problemas

  • Un endpoint del espacio de trabajo rechaza tu clave. Los endpoints bajo /workspace/ necesitan una Clave API del espacio de trabajo, no una Clave API de la empresa.
  • Un endpoint de la empresa rechaza tu clave. La mayoría de los endpoints necesitan una Clave API de la empresa. Revisa la insignia en el endpoint en la referencia de la API.
  • Una solicitud de escritura falla. La clave puede ser Solo lectura. Crea una clave con acceso Lectura/escritura.
  • Una integración dejó de funcionar. La clave puede haber sido revocada o haber alcanzado su expiración. Crea una nueva clave.
  • No ves la tarjeta Ver registros de la API. Solo aparece una vez que tu empresa ha realizado al menos una solicitud.

 

FAQ

  1. ¿Puedo ver el secreto nuevamente después de crear la clave?
    No. Solo se muestra una vez. Si lo pierdes, crea una nueva clave.
     
  2. ¿Puedo restaurar una clave revocada?
    No. Deja de funcionar de inmediato y no puede ser restaurada.
     
  3. ¿Por qué las claves revocadas siguen listadas?
    Por trazabilidad. Usa Eliminar en el menú ⋯ para quitar una de forma permanente.
     
  4. ¿Cuántas solicitudes muestran los registros de la API?
    Las 50 solicitudes REST y MCP más recientes para tu empresa.

¿Te ha sido útil este artículo?

Give feedback about this article

¿No encuentras lo que estás buscando?

Nuestro equipo de servicio al cliente está aquí para ti.

Contáctanos

Knowledge Base Software powered by Helpjuice