Conecta tus aplicaciones empresariales con herramientas externas (ERPs, CRMs, BI, IoT, formularios y plantillas) mediante una interfaz segura y documentada que permite leer y escribir datos en el sistema. Diseñada para facilitar integraciones sin necesidad de programación, habilita flujos flexibles y escalables.
¿Qué resuelve?
Elección libre de soluciones especializadas y combinación de varias a la vez.
Automatización de procesos sin código, orquestando datos entre múltiples plataformas.
Evolución continua de tus aplicaciones sin depender del conocimiento de unas pocas personas.
Capacidades clave
Acceso a recursos del sistema para lectura y inserción de datos.
Documentación con endpoints, parámetros, ejemplos y respuestas de la API.
Integración con ERPs/CRMs y herramientas de BI de terceros.
Dos métodos de autenticación: Bearer Token y Basic.
Alternativas para entornos sin API: integración por archivos y FTP.
Autenticación
Opción 1: Bearer Token (recomendada)
Genera un token en la pantalla OP40 (Tokens).
En tus peticiones HTTP, añade la cabecera:
Authorization: Bearer TU_TOKEN.
curl -X GET "https://api.su-dominio.com/v1/recursos/BP51?limit=50" \ -H "Authorization: Bearer TU_TOKEN" \ -H "Accept: application/json"
Con el token, el sistema reconoce automáticamente el usuario y la empresa asociados, ofreciendo mayor seguridad y sencillez.
Opción 2: Basic
Utiliza el usuario y contraseña del sistema. Debes indicar además el ID de la empresa en los parámetros de la solicitud.
curl -X GET "https://api.su-dominio.com/v1/recursos/BP51?empresa=123" \ -H "Authorization: Basic BASE64(usuario:contraseña)" \ -H "Accept: application/json"
Nota: incluso si la cuenta tiene una sola empresa, es obligatorio informar el parámetro de empresa. Revisa en la documentación el nombre exacto del parámetro.
Recursos y ejemplos
La documentación de referencia detalla todos los recursos disponibles, sus parámetros y respuestas. Cada recurso corresponde a una pantalla o entidad del sistema. Por ejemplo:
BP51: Insumos/Productos (consulta de catálogo, filtros, paginación, etc.).
Ejemplo de consulta de productos/insumos:
GET /v1/recursos/BP51?limit=50&offset=0&buscar=maiz
Para inserciones y actualizaciones, utiliza los métodos HTTP publicados en la documentación del recurso (por ejemplo, POST y PUT/PATCH), con el cuerpo JSON que corresponda al esquema del endpoint.
Integración con BI, IoT y otras aplicaciones
BI: herramientas de terceros pueden leer datos directamente para tableros y análisis.
IoT: dispositivos y pasarelas pueden enviar/recibir datos operativos.
Formularios/plantillas: captura de datos sin código que se sincroniza con el sistema.
Alternativas cuando el tercero no tiene API
Si el sistema externo no dispone de API, es posible integrar mediante intercambio de archivos (por ejemplo, CSV/JSON) y FTP:
El tercero exporta archivos hacia un FTP acordado.
Se procesan y validan los archivos de entrada.
La carga al sistema se realiza utilizando la API interna.
Define formato, codificación, validaciones y calendario de intercambio para asegurar integraciones confiables.
Buenas prácticas
Usa HTTPS siempre. Evita exponer credenciales.
Prefiere Bearer Token frente a Basic. Rota y revoca tokens periódicamente.
Limita permisos del token al mínimo necesario.
Implementa control de tasa, reintentos con backoff y manejo de errores.
Audita las integraciones y registra eventos clave.
Estados de respuesta habituales
200/201: operación exitosa.
400: solicitud inválida (parámetros/faltantes).
401/403: credenciales inválidas o permisos insuficientes.
404: recurso no encontrado.
¿Quién se beneficia?
Administrador de IT: orquestación de integraciones, gobierno y seguridad.
Próximos pasos
Revisa la documentación de referencia para identificar el recurso que necesitas.
Genera un token en OP40 y prueba tus llamadas en una herramienta como Postman.
Define el flujo de integración (API directa o archivos/FTP) y valida en ambiente de pruebas.
Pon en producción con monitoreo, alertas y rotación de credenciales.
Si necesitas apoyo para diseñar o validar tu integración, contacta a Soporte con el detalle de los recursos a utilizar y el método de autenticación elegido.