🏠 Home - 🛡️cs-senda-sapi
This API offers comprehensive services for the management of providers, authorizations, diagnostics, customers, workplace accidents, and more. It includes endpoints for:
- Urgent providers queries
- Authorization and services management
- Diagnostics and historical records handling
- Customer contracts and activities management
- Workplace accidents administration
- Customer coverage verification
- Cataloging of documents, departments, and cities
- Integrated services with Senda
All services are exposed through an organized structure and provide secure access to backend validations.
- API Title: cs-senda-sapi
- Version: 1.0.0
- Base URL:
https://senda-api-prod.us-e1.cloudhub.io/api
🚀 Getting Started
- Authentication: Ensure you have the required
client_id
for secure access. - Base URL: Use the provided Base URL as the prefix for all API endpoints.
- Headers: Add the following headers in your API requests: -H "client_id: YOUR_CLIENT_ID"
🚀 How to Consume
You can access and consume this API through the following platforms:
📍 Available Endpoints
📌 Endpoints Overview
Method | Endpoint | Description | Exchange Link |
---|
GET | /providers/urgent | Get urgent providers | View details |
POST | /authorization | Create authorization | View details |
GET | /authorization/{authorizarionId} | Get authorization by ID | View details |
GET | /authorization/{authorizarionId}/services/{serviceId} | Get authorization with ID and service ID | View details |
POST | /authorization/createNewAuthorization | Create new authorization on Senda | View details |
🔍 Diagnostics and Consultants
Method | Endpoint | Description | Exchange Link |
---|
GET | /diagnotics | Get diagnostics | View details |
GET | /diagnotics/historicals | Get diagnostics historicals | View details |
GET | /consultants/{documentId} | Consultants by document ID | View details |
PUT | /update-diagnostic | Update diagnostic | View details |
👥 Customers and Contracts
Method | Endpoint | Description | Exchange Link |
---|
GET | /customers/{customerId}/coverage-verification | Get customer coverage verification | View details |
GET | /customers/contracts/{contractId} | Get customer contract by ID | View details |
GET | /customers/contracts/{contractId}/activities | Get contract activities | View details |
GET | /client-coverage-verification | Client coverage verification | View details |
📋 Customer Activities
Method | Endpoint | Description | Exchange Link |
---|
POST | /customers/activities | Create customer activities | View details |
GET | /customers/activities | Get customer activities | View details |
POST | /customers/activities/{activityCode}/service-orders | Create service orders | View details |
POST | /customers/activities/{activityCode}/working-sessions | Create working sessions | View details |
POST | /customers/activities/{activityCode}/working-sessions/ratify-sessions | Ratify working sessions | View details |
POST | /customers/activities/{activityCode}/working-sessions/approve-sessions | Approve working sessions | View details |
POST | /customers/activities/{activityCode}/close-activity | Close activity | View details |
POST | /customers/activities/{activityCode}/history-reports | Create history reports | View details |
POST | /customers/activities/working-sessions/supports | Create session supports | View details |
📚 Catalog
Method | Endpoint | Description | Exchange Link |
---|
GET | /catalog/document-list | Get full document list | View details |
GET | /catalog/document-list/{documentId} | Get document by ID | View details |
GET | /catalog/departments-cities | Get common departments | View details |
GET | /catalog/departments | Get departments | View details |
GET | /catalog/departments/{departmentCode}/cities | Get cities | View details |
GET | /catalog/cities/{city} | Get specific city | View details |
GET | /catalog/doctors | Get doctors list | View details |
GET | /catalog/severities | Get severity list | View details |
GET | /catalog/document-types | Get document types | View details |
GET | /catalog/diagnostics-list | Get diagnostics list | View details |
GET | /catalog/accidents | Get accidents list | View details |
🔄 Work Accidents
Method | Endpoint | Description | Exchange Link |
---|
POST | /work-accidents | Create/Notify work accidents | View details |
PUT | /dependent-work-accidents | Update dependent work accident | View details |
GET | /accidents | Get accidents list | View details |
POST | /independent-work-accident | Create independent work accident | View details |
PUT | /update-dependent-work-accident | Update dependent work accident | View details |
POST | /post-create-work-accident | Create work accident | View details |
🗂️ Cases and Filing
Method | Endpoint | Description | Exchange Link |
---|
GET | /esat-cases | Get ESAT cases | View details |
GET | /obtain/cases | Get cases | View details |
GET | /obtain-Ats-Without-Filing-Independently | Obtain an unfiled ATS list of a freelancer | View details |
POST | /filing/diseases | Process of filing an occupational illness | View details |
GET | /obtain-at-without-filing-dependent | Get AT without filing dependent | View details |
GET | /obtain-at-without-filing-independent | Get AT without filing independent | View details |
POST | /case/pqr | Create or update case and task of PQR in Senda | View details |
GET | /cases/{numberAt} | Get Colmena consult case | View details |
👷♂️ Labor Capacity and Workers
Method | Endpoint | Description | Exchange Link |
---|
GET | /labor-capacity-loss | Get labor capacity loss list | View details |
GET | /labor-capacity-loss/{idLcp} | Get labor capacity loss by ID | View details |
GET | /worker | Get worker information | View details |
GET | /generate-pcl-by-document | Generate PCL by document | View details |
🏢 Companies and Addressing
Method | Endpoint | Description | Exchange Link |
---|
GET | /users/permissions | Get user permissions | View details |
GET | /company-information | Get company information | View details |
GET | /ips-addressing | Get IPS addressing | View details |
GET | /sendaGCP/validate-DIS-User | Validate DIS user | View details |
GET | /obtain-company-dialing/{numberContractCoverage} | Get company dialing | View details |
GET | /obtain-special-agreements | Obtain special agreements | View details |
GET | /addressing-colmena/{codeService}/{nameService}/{numberAt}/{city}/{codeCallsignTypeService}/{timeCurrentRequest}/{dayCurrentRequest} | Get addressing Colmena | View details |
GET | /addressing | Request authorization, create an authorization | View details |
GET | /companies-by-dis | DIS service and contracts prevention culture project | View details |
POST | /company-batch | Creating Salesforce companies | View details |
📋 Support and Management
Method | Endpoint | Description | Exchange Link |
---|
POST | /add-at-or-ep-support | Add AT or EP support | View details |
POST | /load-support-image-colmena | Load support image Colmena | View details |
POST | /authorizations | Request authorization, create an authorization | View details |
GET | /authorizations/{numberAt}/{serviceCode} | Get authorizations with numberAt and serviceCode | View details |
GET | /authorizations/reports/{numberAt} | Consult authorization reports by AT number | View details |
GET | /consult-authorization | Consult authorization | View details |
GET | /obtain-information-atel | Obtain information ATEL | View details |
GET | /account-payable | Get accounting information | View details |
GET | /self-service-company | Self service company consultation | View details |
📤 Example Request (Generic)
curl -X GET "https://senda-api-prod.us-e1.cloudhub.io/api/providers/urgent?filter=providerName" \
-H "client_id: YOUR_CLIENT_ID"
Replace parameters based on the specific method.
⚠️ Error Handling
Standard HTTP status codes are used for error handling:
200 OK
– Request was successful400 Bad Request
– Missing or invalid parameters401 Unauthorized
– Authentication failed404 Not Found
– Endpoint or resource not found500 Internal Server Error
– Unexpected error on the server
📞 Support
For any issues, please contact the API support team:
Integration Services and Applications Coordination
📧 support@fgs.co
📅 Notes