Obtener la API key de Crol ERP

Obtener la API key de Crol ERP

CÓMO SE HACE ⏱ 3 min 📦 Para desarrolladores

Generar la API key con la que un sistema externo se conecta a la API de Crol ERP. La creas tú mismo en el Catálogo de APIs, eliges con qué usuario de Crol opera y qué información puede consultar. Con la key copiada, quien desarrolla la integración solicita el token de acceso según la documentación técnica.

Pre-requisitos

  • Ser administrador de la empresa en Crol ERP. El Catálogo de APIs solo está disponible para administradores.
  • Saber con qué usuario de Crol va a operar la integración. La API responde con la información que ese usuario puede ver.
  • Una API key por empresa. Si tu integración trabaja con varias empresas de Crol, genera una en cada una.

Pasos

  1. Abre el menú Configuración y entra a Catálogo de APIs. Pulsa Nuevo.

La pantalla de consulta muestra los registros que ya existen en la empresa, con su Proveedor y si están activos. Cada registro tiene su propia API key.

Pantalla de consulta del Catálogo de APIs de Crol ERP mostrando dos registros, con el menú Configuración y el botón Nuevo resaltados
  1. Escribe en Proveedor el nombre del sistema que se va a conectar y elige el Usuario de crol con el que va a operar.

Los dos campos son obligatorios y se marcan en amarillo. Proveedor es texto libre, así que usa un nombre que tu equipo reconozca, como el del sistema o el de la empresa que hace la integración. La KEY aparece generada desde que pulsas Nuevo, y los campos Usuario y Clave interna están bloqueados porque Crol los genera al guardar.

Registro nuevo del Catálogo de APIs de Crol ERP mostrando los campos Proveedor y Usuario de crol resaltados y la KEY ya generada
  1. En la pestaña Accesos, marca en la columna Consultar la información que tu sistema podrá consultar. Para habilitarla toda de una vez, marca la casilla del encabezado.

Los accesos vienen agrupados por catálogo (Bancos, CFDI, Contabilidad, Contactos, Establecimientos, Productos y servicios y Ventas). La API key solo da acceso a lo que aparece en esta lista y marques en Consultar. Lo que dejes sin marcar no estará disponible para la integración.

Pestaña Accesos del Catálogo de APIs de Crol ERP mostrando resaltada la casilla del encabezado de la columna Consultar
  1. Pulsa Guardar y copia la KEY completa.

La KEY es tu API key. Es un identificador de 36 caracteres con guiones. Cópiala completa, sin espacios al inicio ni al final, y entrégala por un canal seguro a quien desarrolla la integración.

Registro guardado del Catálogo de APIs de Crol ERP mostrando resaltado el campo KEY con la credencial enmascarada
Advertencia: la API key da acceso a la información de tu empresa. Trátala como una contraseña y no la compartas por chat ni por correo abierto.

Resultado esperado

Variaciones / Notas

  • Si pierdes la API key: abre el registro desde la pantalla de consulta del Catálogo de APIs. La KEY sigue visible en el formulario y puedes copiarla de nuevo.
  • Si la API key se compromete: abre el registro, pulsa Modificar, desmarca Activo y guarda. Con eso se corta el acceso de esa key. La KEY de un registro no se regenera, así que genera una nueva con Nuevo y actualiza tu integración.
  • Acceso parcial: si tu integración solo necesita una parte de la información, no marques la casilla del encabezado. Marca uno por uno los accesos que autorizas.
  • Varias empresas: cada empresa de Crol tiene su propio Catálogo de APIs. Repite estos pasos en cada una y usa la key que corresponde.

Errores frecuentes

«No encuentro el Catálogo de APIs en el menú Configuración»

Causa: tu usuario no es administrador de la empresa.

Solución: pide a un administrador de Crol ERP que genere la API key o que te asigne ese perfil.

«La API no acepta la key»

Causa: la key se copió incompleta o con espacios, o el registro tiene desmarcada la casilla Activo.

Solución: abre el registro en el Catálogo de APIs, copia otra vez la KEY completa y verifica que Activo esté marcado.

«La integración no trae la información que esperaba»

Causa: el acceso no está marcado en la pestaña Accesos, o el Usuario de crol del registro no puede ver esa información.

Solución: abre el registro, pulsa Modificar, marca el acceso que falta en la columna Consultar y guarda. Si el acceso ya estaba marcado, revisa los permisos del usuario elegido.

Hazlo simple.