cs-apolo-sapi
The cs-apolo-sapi provides comprehensive access to APOLO database services, offering endpoints for accident certifications, worker management, affiliations, contracts, and financial reporting. It enables secure interaction with headquarters data, employme
home
🏠 Home - 🛡️cs-apolo-sapi
This API offers comprehensive services for data management from the APOLO DB. It includes endpoints for:
- Accident and rate certification queries
- Affiliations and contracts management
- Dependent and independent workers administration
- Headquarters and work centers management
- Affiliation certifications and worker letters
- Economic benefits and reports
- Appointment scheduling and novelty management
- Financial and geographical information queries
- Work-related disease and accident reports
All services are exposed through an organized structure and provide secure access to backend validations.
🌐 Base Information
- API Title: cs-apolo-sapi
- Version: 1.0.0
- Base URL:
https://cs-apolo-sapi-v1-{env}.us-e1.cloudhub.io/api/
- Environment Options: dev, qa
🚀 Getting Started
- Authentication: Ensure you have the required client_id and oauth2 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 "invoker: { "application": "Portal","addressIPUser": "192.168.80.13","loginUser": "User","userName": "User Name" }"
🚀 How to Consume
You can access and consume this API through the following platforms:
📍 Available Endpoints
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
GET | /accident/rate/certification | Get accident rate certification | View details |
POST | /accident/rate/certification/annual | Annual accident rate certification | View details |
GET | /accident/rate/certification/worker | Get worker accident rate certification | View details |
POST | /accident/rate/certification/disability/worker | Get accident rate disability worker certification | View details |
POST | /accidents | Obtain list accidents | View details |
GET | /accidents/headquarters | Obtain accidents headquarters | View details |
POST | /affiliate/certification/letter/dependent | Get affiliate certification letter dependent | View details |
POST | /affiliate/certification/letter/independent | Get affiliate certification letter independent | View details |
POST | /affiliate/certification/annex/dependent | Get affiliate certification annex dependent | View details |
POST | /affiliate-certification-annex-independent | Affiliate certification annex independent | View details |
POST | /affiliations-contracts | Create Affiliation Contract | View details |
GET | /affiliate/ARP | Get Affiliate ARP | View details |
GET | /at/employer/contracting/report | Get AT employer contracting report | View details |
DELETE | /appointment-scheduling | Cancel appointment scheduling | View details |
POST | /appointment-scheduling | Create appointment scheduling | View details |
GET | /cities | Get List Cities | View details |
GET | /cities/contract/{idContract} | Get Cities by Contract Id | View details |
GET | /companies/{id} | Get companies by number | View details |
GET | /companies/policies | Get all Policies | View details |
GET | /companies/contracts/{id} | Get all Contracts by Id | View details |
POST | /companies/contracts/member-by-day-of-birth | Get member by day of birth | View details |
GET | /companies/workers | Get all Workers | View details |
POST | /companies/workers/contact-information | Create a new ContactInformation | View details |
PUT | /companies/workers/contact-information | Update ContactInformation | View details |
GET | /companies/headquarters/{contractConsecutive} | Get Company Headquarters | View details |
POST | /companies/headquarters/certification/current | Get current headquarters certification | View details |
GET | /contacts | Get all Contacts | View details |
POST | /create-dependent-worker | Create Dependent Worker | View details |
GET | /customers | Get all Customers | View details |
GET | /independent-workers/{id} | Get independent Worker Data | View details |
GET | /dependent-workers/{id} | Get Dependent Worker Data | View details |
GET | /dependent-workers-filter/{id} | Get Dependent Worker Data With filter Show | View details |
GET | /economic/benefit/report | Economic Benefit Report | View details |
GET | /providers | Get All Providers | View details |
GET | /v2/companies/contracts/{id} | Get All Contracts by Id | View details |
GET | /participants | Get participants | View details |
GET | /indemnities | Get indemnities | View details |
GET | /policies | Get all policies | View details |
POST | /pymes-affiliations | Create/Notify a New PYME Affiliation | View details |
GET | /pymes-affiliations/{affiliation_id} | Get PYMES Affiliations By Id | View details |
POST | /pymes-affiliations/{affiliation_id}/returns | POST PYMES Affiliations Returns | View details |
POST | /v2/pymes-affiliations/{affiliation_id}/returns | POST PYMES Affiliations Returns | View details |
GET | /info-financial-worker | Get information financial worker | View details |
PUT | /info-financial-worker | Update information financial worker | View details |
GET | /special-agreement | Get information special agreement | View details |
GET | /subsidiary-arp/{id} | Get Subsidiary ARP | View details |
GET | /departments/contract/{idContract} | Get Departments by Contract Id | View details |
POST | /dependent-worker/massive | Create dependent worker for contingency form Jotform-massive | View details |
POST | /dependent-worker | Create dependent worker for contingency form Jotform | View details |
GET | /news/deltas/headquarters | Get Types News Changes Headquarters | View details |
GET | /news/portal | Get Types News Portal | View details |
GET | /type-identificaction | Get Type Identification | View details |
GET | /contracts/work-centers/{contractConsecutive} | Get Contract Work Centers | View details |
POST | /pcc/file-worker-contact | Post pcc File Worker contact | View details |
GET | /headquarters/relationship | Get Headquarters Relationship Report | View details |
GET | /news/companies | Get Types News Portal | View details |
GET | /news/headquarters | Get Types News Portal | View details |
GET | /news/types/workers/independent/filter | Get Types News Portal | View details |
POST | /independent-worker | Create independent worker for contingency form Jotform | View details |
POST | /independent-worker/massive | Create independent worker for contingency form Jotform-massive | View details |
GET | /news/earns-income/independent | Get Types News Portal | View details |
GET | /news/earns-income/dependent | Get Types News Portal | View details |
GET | /quotes/type | Get Type Identification | View details |
GET | /other/news/dependent | Get Types News Portal | View details |
GET | /other/news/independent | Get Types News Portal | View details |
POST | /current/dependent-worker | Current dependent worker-PortalClientes | View details |
POST | /current/independent-worker | Current independent worker-PortalClientes | View details |
GET | /service-liferay/affiliate/contracts/{idTypeIdentification}/{documentNumber} | Obtain Contracts Per Affiliate With Birth | View details |
GET | /service-liferay/affiliate/contracts/card/dependent/{idTypeIdentification}/{documentNumber} | Obtain Card by worker dependent Identification | View details |
GET | /service-liferay/affiliate/contracts/card/independent/{idTypeIdentification}/{documentNumber} | Obtain Card by worker independent Identification | View details |
GET | /service-liferay/affiliate/contracts/card/certificate/{idTypeIdentification}/{documentNumber} | Obtain certificate | View details |
GET | /service-liferay/parametric/platform | Obtain platform | View details |
GET | /service-liferay/parametric/economic-sector | Obtain platform by economic sector | View details |
GET | /service-liferay/admin-courses/courses/course | Obtain courses | View details |
GET | /service-liferay/admin-courses/courses/platform | Obtain courses platform | View details |
GET | /service-liferay/admin-courses/courses/courses-economic-sector | Obtain courses by economic sector | View details |
GET | /service-liferay/admin-courses/courses/courses-detail | Obtain courses detail | View details |
POST | /service-liferay/enrollment/enroll-worker-in-course | Enroll worker in course | View details |
GET | /service-liferay/enrollment/general-enrollment-information/{idTypeIdentification}/{documentNumber} | Get general enrollment information | View details |
GET | /history/news/dependent | Get History Dependent Mock | View details |
GET | /history/news/independent | Get History Independent Mock | View details |
GET | /company | Get Company by Identification Number | View details |
GET | /affiliate/certification/abroad/dependent | Obtain Assistance Certificate Abroad | View details |
POST | /affiliate/certification/special/dependent | Obtain Special Dependent Worker Affiliation Certification | View details |
POST | /affiliate/certification/special/independent | Obtain Special Independent Worker Affiliation Certification | View details |
GET | /current-legal-minimum-wage | Get Current Legal Minimum Wage | View details |
GET | /paid/returns | Get Paid Returns | View details |
GET | /get-support-news | Get Support News | View details |
GET | /load-types-modality | Load Types Modality | View details |
POST | /obtain-dependent-workers-membership | Obtain Dependent Workers Membership | View details |
GET | /certificate-payment-return-contributions | Get Certificate Payment Return Contributions | View details |
POST | /collection-report-worker-o-mass | Obtain Collection Report Worker or Mass | View details |
GET | /obtain-Work-Centers-Number-Of-Workers | Obtain Work Centers Number of Workers | View details |
GET | /obtain-company-work-centers | Obtain Company Work Centers | View details |
GET | /obtain-departments | Get Departments | View details |
GET | /workday | Get workday | View details |
GET | /obtain-AFP-Types | Obtain AFP Types | View details |
GET | /obtain-ARP-Types | Obtain ARP Types | View details |
GET | /obtain-EPS-Types | Obtain EPS Types | View details |
GET | /obtain-Gender-Types | Obtain Gender Types | View details |
GET | /obtain-zone-Types | Obtain zone Types | View details |
GET | /obtain-all-cities | Obtain all cities | View details |
GET | /obtain/certification/company/membership | Obtain Certificate of Company Membership | View details |
GET | /obtain/cases | Get Cases | View details |
GET | /obtain-case-ep-client-portal | Get Case Ep Client Portal | View details |
GET | /obtain-case-at-client-portal | Get Case At Client Portal | View details |
POST | /obtain-events-per-worker | Get Events Per Worker | View details |
GET | /quoteTypesByWorkerType | Get QuoteTypesByWorkerType | View details |
GET | /subtypes/contributor-type-worker | Get subtypes contributor type worker | View details |
GET | /verify-disability-proof | Method responsible for validating if a receipt exists for a consecutive contract | View details |
POST | /workers/dependen/affiliation | Create Workers Dependent Affiliation | View details |
POST | /workers/dependent/certification/affiliation | Obtain Dependent Worker Affiliation Certification | View details |
GET | /workers/dependent/coverage | Create Affiliation Coverage | View details |
GET | /workers/dependent/data | Get Dependent Worker Data | View details |
📤 Example Request (Generic)
curl -X GET "https://cs-apolo-sapi-v1-dev.us-e1.cloudhub.io/api/cities" \
-H "client_id: YOUR_CLIENT_ID" \
-H "invoker: { \"application\": \"Portal\",\"addressIPUser\": \"192.168.80.13\",\"loginUser\": \"User\",\"userName\": \"User Name\" }"
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
📧 epalma@fgs.co
📅 Notes
- Documentation last updated: May 2025
- For further updates, refer to the API Exchange Portal