cs-salesforce-sapi icon

cs-salesforce-sapi

0.0.x
(0 reviews)
La API cs-salesforce-sapi permite una integración segura con Salesforce mediante HTTPS. Ofrece endpoints para gestionar órdenes de trabajo, clientes, reclamaciones, archivos, citas e información de pólizas, con autenticación robusta y confiable.

🛡️ cs-salesforce-sapi

La API cs-salesforce-sapi es una System API que proporciona acceso directo al CRM Salesforce de Colmena Seguros, facilitando operaciones de gestión de documentos, manejo de casos, procesamiento de reclamos y administración de datos de clientes.

Expone operaciones REST para:

  • Gestión de órdenes de trabajo y archivos de servicio
  • Creación y actualización de clientes en Salesforce
  • Procesamiento de PQR (Peticiones, Quejas y Reclamos)
  • Gestión de reclamaciones y reportes de accidentes
  • Consulta de información de pólizas y casos
  • Manejo de autorizaciones Habeas Data
  • Integración con servicios corporativos internos

La API actúa como una System API (SAPI), gestionada desde MuleSoft Anypoint Platform.

🌐 Información Básica

  • Nombre de la API: cs-salesforce-sapi
  • Versión: 1.0.0
  • Plataforma: MuleSoft Anypoint Platform
  • Runtime: Mule 4.4.0
  • Tipo: System API
  • URL Base QA:https://cs-salesforce-sapi-qa-v1.us-e1.cloudhub.io/api/
  • URL Base PROD:https://cs-salesforce-sapi-prod-v1.us-e1.cloudhub.io/api/
  • Protocolo: HTTPS / REST
  • Formato de Datos: JSON

🔐 Autenticación

Para consumir esta API, el consumidor debe enviar obligatoriamente en cada solicitud los siguientes mecanismos de seguridad:

  1. Client ID Enforcement

    • Headers requeridos:
      • client_id
      • client_secret
    • Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.

  2. Bearer Token (OAuth 2.0)

    • Header requerido:
      • Authorization: Bearer <access_token>
    • El token debe ser obtenido desde el servicio corporativo de autenticación.
    • El token debe estar vigente al momento de la solicitud.

Ambos mecanismos son requeridos para que la solicitud sea aceptada por la plataforma.

🔒 Aviso de Seguridad
Las credenciales (client_id, client_secret) y los tokens OAuth son información sensible y no deben compartirse ni almacenarse en repositorios públicos.

🚀 Cómo Consumir

La API se encuentra publicada en las siguientes plataformas:

📋 Para consultar detalles de cada método:

  1. Navegar en el menú izquierdo de la documentación
  2. Expandir la sección "Summary"
  3. Seleccionar el método específico que requiere consultar

📍 Endpoints Disponibles

MétodoEndpointDescripción
POST/workOrdersCrear o actualizar órdenes de trabajo
POST/filesServiceObtener ubicación de Azure o contenido de archivo
POST/customersCrear o actualizar clientes en Salesforce
GET/consultivrInfoObtener información de IVR desde Salesforce
POST/attach-FileAdjuntar archivo a caso de Siebel
GET/consult-Document/{fileId}Consultar documento por ID
POST/complete-PQRCompletar PQR (Petición, Queja o Reclamo)
GET/pqr-Consult-CaseObtener consulta de casos PQR
POST/infoSfdcObtener información desde Salesforce
POST/claimsPresentar indemnizaciones
POST/claims/analytical-responseEntrega de respuesta a analíticas
GET/claims/obtain-filesConsultar documentos por contentVersionId
POST/claims/report-accidentsReportar accidentes
POST/create-appointment-schedulingCrear programación de citas
POST/consult-Attached-DocumentsConsultar documentos adjuntos
GET/retrievePolicyInformationRecuperar información de póliza
GET/token-omniout-salesforceObtener Token Omniout
POST/upload-documents-starservicesSubir documentos relacionados con servicios Star
POST/cases/createCaseCreación de un caso en Salesforce
GET/cases/obtainCasesObtener información de casos en Salesforce
PUT/cases/updateCasesActualizar información de casos en Salesforce
POST/habeasData/dataProcessingAuthorizationAutorización para procesamiento de datos personales
POST/habeasData/bulkDataProcessingAuthorizationAutorización masiva para procesamiento de datos
POST/habeasData/consentRegisterRegistro de autorizaciones Habeas Data
POST/habeasData/bulkConsentRegisterRegistro masivo de autorizaciones Habeas Data
PUT/update-atActualizar AT desde Senda
POST/identity-validation-statusTransunion - Guardar estados de validación en Salesforce
PUT/upsert-status-information-opportunitiesActualizar estado de oportunidades en Salesforce
GET/send-activitiesEnviar actividades desde Senda GCP a Salesforce
GET/cases/{numberAt}Consultar caso por número AT
PATCH/updateEmailStatus/{id}Actualizar estado de correo electrónico
PUT/reserve-adjustmentAjuste de reservas
GET/account/picklist-fieldsObtener valores de lista de selección
GET/account/search-by-identifierBuscar cuenta por identificador
PUT/account/upsert-financial-dataActualizar información financiera de cuentas
POST/automatic-claims-paymentsPagos automáticos de reclamaciones
POST/payment-order-authorizationAutorización de órdenes de pago
POST/policyCoverGestión de productos en proceso de cobertura
POST/notifications/cancelItemEntryAviso a Salesforce la entrada de mercancía anulada
POST/notifications/receiveItemEntryAviso a Salesforce la entrada de mercancía realizada
POST/notifications/receiveInvoiceAviso a Salesforce Factura Recibida
POST/product-catalog/upsertInsertar o crear productos en salesforce
POST/product-catalog/attributesAgrega o actualiza atributos sobre un producto existente
POST/product-catalog/coveragesVincula productos hijo (coberturas) a un producto padre (producto)
POST/product-catalog/classifyClasifica masivamente todos los productos activos
POST/product-catalog/ramo/{ramo}Retorna todos los productos activos de un ramo, incluyendo sus coberturas hijo
POST/product-catalog/code/{productCode}Retorna un único producto con todos sus atributos y coberturas
GET/product-catalogObtiene la lista de todos los productos activos en Salesforce
POST/logistics/{requestId}/statusNotifica cambio de estado de solicitud logística a Salesforce
POST/logistics/{requestId}/approval-resultInforma decisión o resultado de una solicitud de aprobación a Salesforce
POST/logistics/{requestId}/no-travelInforma la decisión de no viaje de una solicitud de aprobación a Salesforce
POST/logistics/items/{itemId}/updateNotifica actualización o problema de un artículo comprado a Salesforce
POST/signio/response/confirmationRecibe la confirmación de firma de documentos desde el sistema Signio

⚠️ Manejo de Errores

La API utiliza códigos HTTP estándar para indicar el resultado del procesamiento de las solicitudes.

Estos códigos representan condiciones de autenticación, autorización, formato o disponibilidad del servicio, y no validaciones funcionales propias del negocio.

CódigoEstadoDescripción
200OKSolicitud procesada correctamente
400Bad RequestSolicitud inválida o mal formada
401UnauthorizedCredenciales inválidas o ausentes
403ForbiddenClient ID sin permisos
404Not FoundRecurso no encontrado
405Method Not AllowedMétodo HTTP no permitido
415Unsupported Media TypeTipo de contenido no soportado
429Too Many RequestsLímite de solicitudes excedido
500Internal Server ErrorError interno inesperado
503Service UnavailableServicio temporalmente no disponible
504Gateway TimeoutTiempo de espera agotado

📞 Soporte

Para soporte técnico o incidencias relacionadas con la integración:

Coordinación de Servicios de Integración y Aplicaciones

📅 Información Adicional

Documentación creada en Febrero 2026 – Fundación Grupo Social – Colmena

© 2026 Fundación Grupo Social – Colmena

Esta documentación se mantiene actualizada conforme se incorporan nuevos servicios o endpoints relacionados con Salesforce.

Reviews