Integración mediante API

Las API te permiten conectar tu sistema con Moonflow para consultar o enviar información automáticamente, sin necesidad de hacerlo manualmente desde la plataforma. Funciona como un canal de comunicación entre ambos sistemas; es a demanda, es decir, desde tu sistema deben hacer una petición con la API Key correspondiente.

Por ejemplo, puedes usar la API para:

• Crear o actualizar clientes
• Enviar órdenes de pago
• Reportar pagos
• Consultar saldos

La API Key es una clave única que identifica a tu sistema al conectarse con Moonflow. Es como una llave privada: solo quienes tengan esa clave pueden acceder al proyecto que representa. Funciona como una llave de acceso para que puedas transferir información de forma segura entre sistemas.

Ten en cuenta que:

• Cada proyecto tiene su propia API Key.
• No se repite en otros proyectos.
• Puedes configurar los permisos que tiene cada clave (por ejemplo, solo crear clientes o solo consultar saldos).
• Puedes tener varias claves activas al mismo tiempo, con distintos permisos.

1. Ve a la parte superior derecha del Dashboard y haz clic en Ajustes (ícono del engranaje ⚙️).

2. Selecciona la sección Integraciones.

3. En la pestaña correspondiente, haz clic en Añadir para generar tu nueva credencial.

4. Asígnale un nombre a la conexión y configura los permisos.

5. Haz clic en Guardar. Una vez hecho esto, tendrás acceso a tu API Key.

Desde esta misma sección podrás descargar la documentación técnica con instrucciones para configurar la conexión.

No. Puedes crear y usar tantas claves API como necesites.

Pueden estar activas al mismo tiempo y cada una puede tener permisos distintos, como si fueran usuarios.

Por ejemplo:

• Una clave para un sistema que solo crea órdenes de pago.
• Otra clave para otro sistema que solo actualiza clientes.

Asegúrate de enviar los datos en el cuerpo de la solicitud HTTP (body) utilizando el formato JSON adecuado. No debes incluir los datos como parámetros en la URL (params), ya que esto puede generar errores en el procesamiento de la información.

Por ejemplo, para crear una orden de pago, utiliza una solicitud POST con el siguiente formato:

{
  "documentNumber": "12345678",
  "amount": 100.0,
  "dueDate": "2025-06-30"
}

Evita enviar los datos de esta manera:

POST /api/paymentorder?documentNumber=12345678&amount=100.0&dueDate=2025-06-30

Error 500: ocurre cuando algo falla en el servidor al procesar la solicitud. Es un error interno que no depende de los datos que enviaste.

Error 401: ocurre si el token no es válido.

Error 403: aparece cuando se alcanzó el límite de uso o no se tiene acceso al endpoint.

Error 409: indica un conflicto con los datos enviados.

• Es automática y segura.

• Permite actualizar información en tiempo real o por lotes.

• Reduce errores asociados a cargas manuales.

• Optimiza el trabajo cuando manejas grandes volúmenes de datos o necesitas integraciones constantes.

• Te recomendamos utilizar el modo API Batch: este formato permite enviar hasta 5.000 objetos por solicitud y se procesa de forma asíncrona, lo que mejora la eficiencia del intercambio de datos.

• Moonflow acepta hasta 20 peticiones por minuto. Si superas este límite, recibirás un error de respuesta.

• Cada lote genera un batchId, que puedes consultar para verificar el estado del procesamiento. Si hay errores, el sistema te mostrará la posición y el detalle del problema. Consulta la sección 1.6.1 de la documentación técnica para más información.

• Descarga la documentación técnica desde Ajustes > Integraciones > Métodos de integración > API.

• 💡 Recuerda: Esta integración requiere que tu sistema esté preparado para enviar la información estructurada según los campos que Moonflow espera recibir. Si tu ERP o CRM tiene limitaciones, revisa con tu equipo técnico qué datos pueden sincronizarse y cómo adaptarlos al formato necesario.