cs-apolo-sapi icon

cs-apolo-sapi

(0 reviews)
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

  1. Authentication: Ensure you have the required client_id and oauth2 for secure access.
  2. Base URL: Use the provided Base URL as the prefix for all API endpoints.
  3. 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

MethodEndpointDescriptionExchange Link
GET/accident/rate/certificationGet accident rate certificationView details
POST/accident/rate/certification/annualAnnual accident rate certificationView details
GET/accident/rate/certification/workerGet worker accident rate certificationView details
POST/accident/rate/certification/disability/workerGet accident rate disability worker certificationView details
POST/accidentsObtain list accidentsView details
GET/accidents/headquartersObtain accidents headquartersView details
POST/affiliate/certification/letter/dependentGet affiliate certification letter dependentView details
POST/affiliate/certification/letter/independentGet affiliate certification letter independentView details
POST/affiliate/certification/annex/dependentGet affiliate certification annex dependentView details
POST/affiliate-certification-annex-independentAffiliate certification annex independentView details
POST/affiliations-contractsCreate Affiliation ContractView details
GET/affiliate/ARPGet Affiliate ARPView details
GET/at/employer/contracting/reportGet AT employer contracting reportView details
DELETE/appointment-schedulingCancel appointment schedulingView details
POST/appointment-schedulingCreate appointment schedulingView details
GET/citiesGet List CitiesView details
GET/cities/contract/{idContract}Get Cities by Contract IdView details
GET/companies/{id}Get companies by numberView details
GET/companies/policiesGet all PoliciesView details
GET/companies/contracts/{id}Get all Contracts by IdView details
POST/companies/contracts/member-by-day-of-birthGet member by day of birthView details
GET/companies/workersGet all WorkersView details
POST/companies/workers/contact-informationCreate a new ContactInformationView details
PUT/companies/workers/contact-informationUpdate ContactInformationView details
GET/companies/headquarters/{contractConsecutive}Get Company HeadquartersView details
POST/companies/headquarters/certification/currentGet current headquarters certificationView details
GET/contactsGet all ContactsView details
POST/create-dependent-workerCreate Dependent WorkerView details
GET/customersGet all CustomersView details
GET/independent-workers/{id}Get independent Worker DataView details
GET/dependent-workers/{id}Get Dependent Worker DataView details
GET/dependent-workers-filter/{id}Get Dependent Worker Data With filter ShowView details
GET/economic/benefit/reportEconomic Benefit ReportView details
GET/providersGet All ProvidersView details
GET/v2/companies/contracts/{id}Get All Contracts by IdView details
GET/participantsGet participantsView details
GET/indemnitiesGet indemnitiesView details
GET/policiesGet all policiesView details
POST/pymes-affiliationsCreate/Notify a New PYME AffiliationView details
GET/pymes-affiliations/{affiliation_id}Get PYMES Affiliations By IdView details
POST/pymes-affiliations/{affiliation_id}/returnsPOST PYMES Affiliations ReturnsView details
POST/v2/pymes-affiliations/{affiliation_id}/returnsPOST PYMES Affiliations ReturnsView details
GET/info-financial-workerGet information financial workerView details
PUT/info-financial-workerUpdate information financial workerView details
GET/special-agreementGet information special agreementView details
GET/subsidiary-arp/{id}Get Subsidiary ARPView details
GET/departments/contract/{idContract}Get Departments by Contract IdView details
POST/dependent-worker/massiveCreate dependent worker for contingency form Jotform-massiveView details
POST/dependent-workerCreate dependent worker for contingency form JotformView details
GET/news/deltas/headquartersGet Types News Changes HeadquartersView details
GET/news/portalGet Types News PortalView details
GET/type-identificactionGet Type IdentificationView details
GET/contracts/work-centers/{contractConsecutive}Get Contract Work CentersView details
POST/pcc/file-worker-contactPost pcc File Worker contactView details
GET/headquarters/relationshipGet Headquarters Relationship ReportView details
GET/news/companiesGet Types News PortalView details
GET/news/headquartersGet Types News PortalView details
GET/news/types/workers/independent/filterGet Types News PortalView details
POST/independent-workerCreate independent worker for contingency form JotformView details
POST/independent-worker/massiveCreate independent worker for contingency form Jotform-massiveView details
GET/news/earns-income/independentGet Types News PortalView details
GET/news/earns-income/dependentGet Types News PortalView details
GET/quotes/typeGet Type IdentificationView details
GET/other/news/dependentGet Types News PortalView details
GET/other/news/independentGet Types News PortalView details
POST/current/dependent-workerCurrent dependent worker-PortalClientesView details
POST/current/independent-workerCurrent independent worker-PortalClientesView details
GET/service-liferay/affiliate/contracts/{idTypeIdentification}/{documentNumber}Obtain Contracts Per Affiliate With BirthView details
GET/service-liferay/affiliate/contracts/card/dependent/{idTypeIdentification}/{documentNumber}Obtain Card by worker dependent IdentificationView details
GET/service-liferay/affiliate/contracts/card/independent/{idTypeIdentification}/{documentNumber}Obtain Card by worker independent IdentificationView details
GET/service-liferay/affiliate/contracts/card/certificate/{idTypeIdentification}/{documentNumber}Obtain certificateView details
GET/service-liferay/parametric/platformObtain platformView details
GET/service-liferay/parametric/economic-sectorObtain platform by economic sectorView details
GET/service-liferay/admin-courses/courses/courseObtain coursesView details
GET/service-liferay/admin-courses/courses/platformObtain courses platformView details
GET/service-liferay/admin-courses/courses/courses-economic-sectorObtain courses by economic sectorView details
GET/service-liferay/admin-courses/courses/courses-detailObtain courses detailView details
POST/service-liferay/enrollment/enroll-worker-in-courseEnroll worker in courseView details
GET/service-liferay/enrollment/general-enrollment-information/{idTypeIdentification}/{documentNumber}Get general enrollment informationView details
GET/history/news/dependentGet History Dependent MockView details
GET/history/news/independentGet History Independent MockView details
GET/companyGet Company by Identification NumberView details
GET/affiliate/certification/abroad/dependentObtain Assistance Certificate AbroadView details
POST/affiliate/certification/special/dependentObtain Special Dependent Worker Affiliation CertificationView details
POST/affiliate/certification/special/independentObtain Special Independent Worker Affiliation CertificationView details
GET/current-legal-minimum-wageGet Current Legal Minimum WageView details
GET/paid/returnsGet Paid ReturnsView details
GET/get-support-newsGet Support NewsView details
GET/load-types-modalityLoad Types ModalityView details
POST/obtain-dependent-workers-membershipObtain Dependent Workers MembershipView details
GET/certificate-payment-return-contributionsGet Certificate Payment Return ContributionsView details
POST/collection-report-worker-o-massObtain Collection Report Worker or MassView details
GET/obtain-Work-Centers-Number-Of-WorkersObtain Work Centers Number of WorkersView details
GET/obtain-company-work-centersObtain Company Work CentersView details
GET/obtain-departmentsGet DepartmentsView details
GET/workdayGet workdayView details
GET/obtain-AFP-TypesObtain AFP TypesView details
GET/obtain-ARP-TypesObtain ARP TypesView details
GET/obtain-EPS-TypesObtain EPS TypesView details
GET/obtain-Gender-TypesObtain Gender TypesView details
GET/obtain-zone-TypesObtain zone TypesView details
GET/obtain-all-citiesObtain all citiesView details
GET/obtain/certification/company/membershipObtain Certificate of Company MembershipView details
GET/obtain/casesGet CasesView details
GET/obtain-case-ep-client-portalGet Case Ep Client PortalView details
GET/obtain-case-at-client-portalGet Case At Client PortalView details
POST/obtain-events-per-workerGet Events Per WorkerView details
GET/quoteTypesByWorkerTypeGet QuoteTypesByWorkerTypeView details
GET/subtypes/contributor-type-workerGet subtypes contributor type workerView details
GET/verify-disability-proofMethod responsible for validating if a receipt exists for a consecutive contractView details
POST/workers/dependen/affiliationCreate Workers Dependent AffiliationView details
POST/workers/dependent/certification/affiliationObtain Dependent Worker Affiliation CertificationView details
GET/workers/dependent/coverageCreate Affiliation CoverageView details
GET/workers/dependent/dataGet Dependent Worker DataView 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 successful
  • 400 Bad Request – Missing or invalid parameters
  • 401 Unauthorized – Authentication failed
  • 404 Not Found – Endpoint or resource not found
  • 500 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


Reviews