cs-salesforce-sapi icon

cs-salesforce-sapi

0.0.x
(0 reviews)
The cs-salesforce-sapi is a comprehensive system API for Salesforce integration, enabling secure data exchange via HTTPS. It provides endpoints for managing work orders, customers, claims, files, appointments, and policy information with robust authentica

🏠 Home - 🧾 cs-salesforce-sapi

The cs-salesforce-sapi API is a System API for Colmena Seguros' Salesforce CRM that provides an interface for direct operations with the Salesforce system, facilitating document management, case handling, claims processing, and customer activity tracking.

This API serves as a fundamental connector for Salesforce CRM functionalities, allowing integration with various internal systems and providing access to critical business operations.

🌐 Basic Information

  • API Title: cs-salesforce-sapi
  • Version: 1.0.0
  • Base URL: https://cs-salesforce-sapi-{env}-v1.us-e1.cloudhub.io/api/
  • Environments:
    • dev
    • qa
    • prod

🚀 How to Get Started

  1. Authentication: You must include a valid client_id to authenticate all API requests using the client-id-enforcement and OAuth2 security schemes.
  2. Base URL Usage: Use the Base URL above as the root for all endpoints.
  3. Headers: All endpoints require common request headers as defined in the API specification.

📍 Available Endpoints

📌 Endpoints Overview

MethodEndpointDescriptionExchange Link
POST/workOrdersCreate or update work ordersView Details
POST/filesServiceGet azure location or file content for service fileView Details
POST/customersCreate or update customers in SalesforceView Details
GET/consultivrInfoGet IVR info from SalesforceView Details
POST/attach-FileAttach File To Siebel CaseView Details
GET/consult-Document/{fileId}Consult Document by IDView Details
POST/complete-PQRComplete PQR (Petition, Complaint or Claim)View Details
GET/pqr-Consult-CaseGet Consult PQR casesView Details
POST/infoSfdcGet info from SalesforceView Details
POST/claimsFiling indemnitiesView Details
POST/claims/analytical-responseDelivery of response to analyticsView Details
GET/claims/obtain-filesQuery documents in Salesforce through contentVersionIdView Details
POST/claims/report-accidentsOperation to report accidentsView Details
POST/create-appointment-schedulingCreate appointment scheduling from MaryView Details
POST/consult-Attached-DocumentsConsult attached documentsView Details
GET/retrievePolicyInformationRetrieve Policy InformationView Details
GET/token-omniout-salesforceGet Token OmnioutView Details
POST/upload-documents-starservicesUpload documents related to Star servicesView Details
GET/cases/obtainCasesObtain information from the case object in SalesforceView Details
PUT/cases/updateCasesUpdate information from the case object in SalesforceView Details
POST/habeasData/dataProcessingAuthorizationAuthorization for processing personal dataView Details
PUT/update-atUpdate AT from SendaView Details
POST/identity-validation-statusTransunion - IVR Save states to SalesforceView Details
PUT/upsert-status-information-opportunitiesService that updates the status of opportunities in SalesforceView Details
GET/send-activitiesSend activities from Senda GCP to SalesforceView Details

⚠️ Error Handling

The API uses standard HTTP response codes to indicate the success or failure of requests:

  • 200 OK – Request succeeded
  • 400 Bad Request – Input validation error
  • 401 Unauthorized – Authentication failed
  • 404 Not Found – The requested resource was not found
  • 500 Internal Server Error – Unexpected server-side error

The API implements common HTTP error code handling as indicated in the RAML specification.

📞 Support

For any issues, please contact the API support team:

Integration Services and Applications Coordination

📧 epalma@fgs.co

📅 Notes

Reviews