cs-salesforce-crm-xapi
home
🧾 cs-salesforce-crm-xapi
La API cs-salesforce-crm-xapi
es una API de Experiencia para el CRM de Salesforce de Colmena Seguros que proporciona una interfaz unificada para operaciones a través de múltiples sistemas y servicios incluyendo Azure Storage, Salesforce y Senda, permitiendo un acceso simplificado a operaciones críticas del negocio.
Esta API sirve como un conector crucial para las funcionalidades del CRM de Salesforce, facilitando la gestión de documentos, manejo de casos, procesamiento de reclamos y seguimiento de actividades de clientes.
🌐 Información Básica
- Título de la API: cs-salesforce-crm-xapi
- Versión: 1.0.0
- URL Base:
https://cs-salesforce-crm-xapi.cloudhub.com/
- Ambientes:
dev
qa
prod
🚀 Cómo Comenzar
- Autenticación: Debes incluir un
client_id
válido para autenticar todas las solicitudes de API usando el esquema de seguridad client-id-enforcement. - Uso de URL Base: Usa la URL Base anterior como raíz para todos los endpoints.
- Encabezados: Todos los endpoints requieren encabezados de solicitud comunes según se define en la especificación de la API.
📍 Endpoints Disponibles
Método | Endpoint | Descripción | Enlace Exchange |
---|---|---|---|
POST | /azure/storage | Guardar un archivo en Azure Storage | Ver Detalles |
GET | /azure/storage | Obtener un archivo de Azure Storage | Ver Detalles |
POST | /senda/case | Crear o actualizar casos y tareas en Senda Medico | Ver Detalles |
GET | /senda/consultants/{documentId} | Recuperar información de consultor por ID de documento | Ver Detalles |
GET | /senda/customers/contracts/{contractId} | Obtener información del contrato del cliente | Ver Detalles |
GET | /senda/customers/contracts/{contractId}/activities | Obtener actividades del contrato con filtro de estado opcional | Ver Detalles |
POST | /senda/customers/activities | Crear un nuevo registro de actividad en SENDA | Ver Detalles |
PUT | /senda/customers/activities/{activityId}/status | Actualizar estado de una actividad de cliente | Ver Detalles |
POST | /senda/customers/activities/{activityId}/history-reports | Crear reportes de historial de actividades | Ver Detalles |
POST | /senda/customers/activities/{activityId}/service-orders | Crear órdenes de servicio para actividades | Ver Detalles |
POST | /senda/customers/activities/{activityId}/working-sessions | Crear sesiones de trabajo para actividades | Ver Detalles |
POST | /senda/customers/activities/{activityId}/working-sessions/approve-sessions | Aprobar sesiones de trabajo | Ver Detalles |
PUT | /senda/customers/activities/{activityId}/working-sessions/status | Actualizar estado de sesión de trabajo | Ver Detalles |
POST | /senda/customers/activities/working-sessions/supports | Agregar información de soporte a sesiones de trabajo | Ver Detalles |
POST | /claims | Presentar reclamos de indemnización | Ver Detalles |
POST | /claims/analytical-response | Entregar respuesta a analíticas | Ver Detalles |
GET | /claims/obtain-files | Consultar documentos en Salesforce a través de contentVersionId | Ver Detalles |
POST | /claims/reportAnalytics | Reportar reclamo a analíticas | Ver Detalles |
POST | /attach-File | Adjuntar archivo a caso de Siebel | Ver Detalles |
GET | /consult-Document/{fileId} | Consultar documento por ID de archivo | Ver Detalles |
POST | /complete-PQR | Completar proceso PQR (Peticiones, Quejas, Reclamos) | Ver Detalles |
GET | /pqr-Consult-Case | Obtener casos PQR dentro de un rango de fechas | Ver Detalles |
POST | /create-appointment-scheduling | Crear programación de citas desde Mary | Ver Detalles |
GET | /obtain-information-called-from-senda-medico | Obtener información de llamadas desde Senda Medico | Ver Detalles |
POST | /consult-Attached-Documents | Consultar documentos adjuntos | Ver Detalles |
GET | /retrievePolicyInformation | Recuperar información de póliza | Ver Detalles |
GET | /token-omniout-salesforce | Obtener Token Omniout | Ver Detalles |
POST | /upload-documents-starservices | Subir documentos a Star Services | Ver Detalles |
GET | /cases/obtainCases | Obtener información del objeto caso de Salesforce | Ver Detalles |
PUT | /cases/updateCases | Actualizar información en objeto caso de Salesforce | Ver Detalles |
POST | /habeasData/dataProcessingAuthorization | Autorización para procesamiento de datos personales | Ver Detalles |
POST | /post-create-work-accident | Crear registro de accidente laboral | Ver Detalles |
GET | /obtain-special-agreements | Obtener acuerdos especiales por número de contrato | Ver Detalles |
PUT | /update-at | Actualizar AT desde Senda | Ver Detalles |
⚠️ Manejo de Errores
La API utiliza códigos de respuesta HTTP estándar para indicar el éxito o falla de las solicitudes:
200 OK
– Solicitud exitosa400 Bad Request
– Error de validación de entrada401 Unauthorized
– Autenticación fallida404 Not Found
– El recurso solicitado no fue encontrado500 Internal Server Error
– Error inesperado del lado del servidor
La API implementa manejo común de códigos de error HTTP según se indica en la especificación RAML.
📞 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 actualizada por última vez: Septiembre 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services