cs-jotform-sapi

(0 reviews)

Servicio de integración que conecta con Jotform para administrar formularios digitales. Permite consultar archivos, obtener listados de envíos y actualizar información de formularios de manera segura y eficiente.

🛡️ cs-jotform-sapi

Esta API proporciona servicios de integración con la plataforma Jotform para la gestión automatizada de formularios digitales. Incluye endpoints para:

Consulta de archivos adjuntos en formularios
Recuperación de envíos de formularios con filtros personalizados
Actualización y gestión de datos de envíos existentes
Integración completa con Jotform API
Paginación y filtrado avanzado de resultados
Trazabilidad completa de transacciones

Todos los servicios se exponen a través de endpoints REST optimizados que proporcionan acceso seguro a la plataforma Jotform con autenticación mediante API Key, garantizando alta disponibilidad y rendimiento.

🌐 Información Base

Título de la API: cs-jotform-sapi
Versión: 1.0.0
Plataforma: MuleSoft Anypoint Platform
URL Base Producción: https://cs-jotform-sapi-prod.us-e1.cloudhub.io/api/
URL Base QA: https://cs-jotform-sapi-qa.us-e1.cloudhub.io/api/
Protocolo: REST
Formato de Datos: JSON
Autenticación: API Key + Client ID Enforcement
API ID: 17573590

🚀 Cómo Comenzar

Autenticación: Asegúrate de tener el client_id requerido para acceso seguro mediante políticas de API Manager.
URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
Encabezados: Agrega los siguientes encabezados en tus solicitudes de API:

-H "Content-Type: application/json"
-H "client_id: TU_CLIENT_ID"
-H "x-transaction-id: TU_TRANSACTION_ID"  # Opcional pero recomendado para trazabilidad

🚀 Cómo Consumir

Puedes acceder y consumir esta API a través de las siguientes plataformas:

🔗 MuleSoft Exchange
🔗 Portal Público FGS

📍 Endpoints Disponibles

Método	Endpoint	Descripción
GET	`/api/form/{formId}/files`	Obtener lista completa de archivos adjuntos asociados a un formulario específico
GET	`/api/form/{formId}/submissions`	Recuperar todos los envíos de un formulario con opciones de filtrado y paginación
POST	`/api/submission/{submissionId}`	Actualizar datos de un envío existente con nueva información o modificaciones

📤 Ejemplos de Uso

Ejemplo 1: Obtener archivos de un formulario

curl --location 'https://cs-jotform-sapi-qa.us-e1.cloudhub.io/api/form/241234567890/files' \
  -H "client_id: {client_id}" \
  -H "x-transaction-id: {transaction_id}" \
  -H "Content-Type: application/json"

Respuesta Exitosa (200 OK):

{
  "responseCode": "200",
  "message": "Success",
  "duration": "1234",
  "resultSet": {
    "count": "5"
  },
  "content": [
    {
      "name": "documento.pdf",
      "type": "application/pdf",
      "size": "245678",
      "username": "usuario@colmena.com",
      "formId": "241234567890",
      "submissionId": "5678901234",
      "date": "2025-11-11 10:30:00",
      "url": "https://colmenaseguros.jotform.com/uploads/documento.pdf"
    }
  ]
}

⚠️ Manejo de Errores

Se utilizan códigos de estado HTTP estándar para el manejo de errores:

📊 Códigos de Respuesta

Código	Estado	Descripción	Causa Común	Acción Recomendada
`200`	✅ OK	La solicitud fue exitosa	Operación completada correctamente	Continuar con el procesamiento
`400`	❌ Bad Request	Parámetros faltantes o inválidos	Formato de datos incorrecto, formId inválido	Revisar estructura del JSON y parámetros requeridos
`401`	🔒 Unauthorized	Autenticación fallida	Client_id inválido o faltante	Verificar client_id en headers
`403`	🚫 Forbidden	Sin permisos suficientes	Client_id sin permisos para el endpoint	Verificar permisos asignados al client_id
`404`	🔍 Not Found	Recurso no encontrado	formId o submissionId inexistente	Verificar que los IDs sean correctos
`405`	🚷 Method Not Allowed	Método HTTP no permitido	Usar GET en vez de POST o viceversa	Verificar el método HTTP correcto
`406`	⚠️ Not Acceptable	Formato de respuesta no aceptable	Header Accept incorrecto	Usar Content-Type: application/json
`415`	📎 Unsupported Media Type	Tipo de contenido no soportado	Content-Type incorrecto	Usar Content-Type: application/json
`429`	⏰ Rate Limited	Demasiadas solicitudes	Exceso de requests por minuto	Implementar retry con exponential backoff
`500`	💥 Internal Server Error	Error inesperado en el servidor	Fallo interno del sistema o de Jotform API	Contactar soporte técnico con transaction ID
`501`	🛠️ Not Implemented	Funcionalidad no implementada	Endpoint o feature no disponible	Verificar documentación de endpoints
`503`	🛠️ Service Unavailable	Servicio temporalmente no disponible	Mantenimiento o sobrecarga de Jotform	Reintentar más tarde

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

Documentación creada en Noviembre 2025 - Fundación Grupo Social - Colmena

📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente y cambios en tiempo real, consulta siempre el Portal de Exchange oficial.

🔒 Aviso de Seguridad: Nunca compartas credenciales de API (client_id, API keys) en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y gestiona credenciales mediante secretos seguros.

⚡ Nota de Rendimiento: Para consultas de envíos con grandes volúmenes de datos, usa siempre paginación (limit/offset) para optimizar tiempos de respuesta y consumo de recursos.

home