cs-apolo-sapi-v2
A flexible REST-based connector that provides secure, standardized access to APOLO database v2. This API offers comprehensive endpoints for worker management, headquarters operations, and health services data, enabling seamless integration with enterprise
home
🏠 Home - 🛡️cs-apolo2-sapi
This API provides secure access to APOLO 2 database services, offering functionality for:
- Accident certification and worker disability management
- Affiliate administration (dependent and independent workers)
- Company contracts and headquarters management
- Certificate generation and documentation services
- Appointment scheduling and case management
- Financial and geographical data services
All endpoints are organized in a structured manner with enhanced security and optimized performance.
🌐 Base Information
- API Title: cs-apolo2-sapi
- Base URL:
https://cs-apolo2-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 |
|---|---|---|---|
| POST | /create-independent-worker | Create Independent Worker | View details |
| POST | /create/new/change/date/birth/independent | Create New Change Date of Birth Independent | View details |
| POST | /create/novelty/change/working/independent | Create Novelty Change Independent Working day | View details |
| POST | /create-novelty-change-locality-commune-independent | Create novelty change locality commune independent | View details |
| POST | /create-novelty-change-phone-independent | Create novelty change phone independent | View details |
| POST | /create-novelty-independent-sex-change | Create novelty independent sex change | View details |
| POST | /create-novelty-dependent-sex-change | Create novelty dependent sex change | View details |
| POST | /create-new-modification-start-date-independent-coverage | Create new modification start date independent coverage | View details |
| POST | /create-new-modification-start-date-dependent-coverage | Create new modification start date dependent coverage | View details |
| POST | /create-novelty-change-zone-independent | Create novelty change zone independent | View details |
| GET | /obtain-card-by-headquarters-independent | Obtain card by headquarters independent | View details |
| GET | /obtain-support-affiliation-independent | Obtain Support Affiliation Independent | View details |
| GET | /basic-affiliate-report | Get basic-affiliate-report | View details |
| GET | /cards-by-department-and-independent-city | Get cards by department and independent city | View details |
| GET | /cards-by-date-new-independent-entry | Get cards by date new independent entry | View details |
| GET | /obtain-novelty-future-worker-independent | Obtain novelty future worker independent | View details |
| GET | /obtain-novelty-recent-worker-independent | Obtain novelty recent worker independent | View details |
| POST | /create-new-independent-retirement | Create New Independent Retirement | View details |
| POST | /create-new-dependent-retirement | Create New Dependent Retirement | View details |
| GET | /support-new-worker | Get Support New Worker | View details |
| GET | /obtain-types-employment-link | Obtain types employment link | View details |
| GET | /obtain-types-employment-link-worker | Obtain types employment link worker | View details |
| GET | /obtain-types-habitual-occupation | Obtain Types of Habitual Occupation | View details |
| GET | /obtain-types-accidents | Obtain types accidents | View details |
| GET | /obtain-sites-accident | Obtain sites accident | View details |
| GET | /obtain-types-injury | Obtain types injury | View details |
| GET | /obtain-body-parts | Obtain body parts | View details |
| GET | /obtain-accident-agent | Obtain accident agent | View details |
| GET | /obtain-accident-forms | Obtain accident forms | View details |
| GET | /obtain-all-contracts-Worker | Obtain the list of all workers contracts | View details |
| GET | /load-zone-types | Load zone types | View details |
| GET | /obtain-contracts-by-independent-worker | Obtain contracts by independent worker | View details |
| POST | /create-new-change-independent-headquarters | Create new change independent headquarters | View details |
| POST | /create-new-change-dependent-headquarters | Create new change dependent headquarters | View details |
| GET | /files-sent-by-independent-date-ranges | Files Sent by independent date ranges | View details |
| GET | /obtain-types-risk-factors-disease | Obtain types risk factor's disease | View details |
| GET | /obtain-card-by-city-state-dependent | Obtain card by city state dependent | View details |
| GET | /obtain-card-by-novelty-entry-date-dependent | Obtain card by novelty entry date dependent | View details |
| GET | /obtain-card-by-headquarters-dependent | Obtain card by headquarters dependent | View details |
| POST | /bulk-upload-independents | Bulk upload independents | View details |
| GET | /obtain-retroactive-withdrawals-closing | Obtain retroactive withdrawals closing | View details |
| POST | /create-novelty-cancellation-entry-dependent | Create novelty cancellation entry dependent | View details |
| POST | /create-novelty-change-locality-commune-dependent | Create novelty change locality commune dependent | View details |
| POST | /create-novelty-change-phone-dependent | Create novelty change phone dependent | View details |
| POST | /create-novelty-change-zone-dependent | Create novelty change zone dependent | View details |
| GET | /obtain-retroActive-withdrawals-theDay-closing | Obtain retroActive withdrawals theDay closing | View details |
| GET | /create-new-change-dependent-email | Get create-new-change-dependent-email | View details |
| POST | /create-novelty-change-Eps-dependent | Create New Change dependent Identification | View details |
| GET | /create-new-change-Afp-dependent | Get create-new-change-Afp-dependent | View details |
| GET | /create-novelty-change-dependent-cellPhone | Get create novelty change dependent cell Phone | View details |
| GET | /obtain-files-sent-retroactive-withdrawal-closing | Obtain files sent retroactive withdrawal closing | View details |
| GET | /obtain-novelty-future-worker-dependent | Obtain novelty future worker dependent | View details |
| POST | /create-novelty-cancellation-retirement-dependent | Create novelty cancellation retirement dependent | View details |
| POST | /create-novelty-change-city-dependent | Create novelty change city dependent | View details |
| POST | /create-novelty-change-position-dependent | Create novelty change position dependent | View details |
| POST | /health-service/employer/membership-Arl | Employer membership ARL | View details |
| POST | /health-service/employer/retractionTransferOrEmployerAffiliationArl | Retraction Transfer Or Employer Affiliation ARL | View details |
| POST | /health-service/employer/beginningEmploymentRelationship | Beginning Employment Relationship | View details |
| POST | /health-service/employer/terminationEmploymentRelationship | Termination Employment Relationship | View details |
| POST | /health-service/headquarters/noveltyNotification | Headquarters novelty notification | View details |
| POST | /health-service/workCenter/novelties | Work Center novelties | View details |
| POST | /health-service/workCenter/variationWorkCenterforDependentWorkersAndStudents | Variation Work Center for Dependent Workers And Students | View details |
| POST | /health-service/arlEmployerTransfer/origin-ARL | ARL Employer Transfer origin-ARL | View details |
| POST | /health-service/arlEmployerTransfer/destination-ARL/transferNotification | ARL Employer Transfer destination-ARL transfer notification | View details |
| GET | /create-new-change-date-of-birth-dependent | Get create new change date of birth dependent | View details |
| GET | /create-new-change-identification-dependent | Get create new change identification dependent | View details |
| GET | /support-new-extension-end-independent-validity | Get support new extension end independent validity | View details |
| GET | /medical-evaluations | Get medical evaluations | View details |
| PUT | /update-work-accident-independent | Update work accident independent | View details |
| POST | /create-novelty-retroactive-retirement-individual-closing | Create novelty retroactive retirement individual closing | View details |
| POST | /create-novelty-retirement-retroactive-massive-closing | Create novelty retirement retroactive massive closing | View details |
| POST | /create-novelty-change-journey-dependent | Create novelty change journey dependent | View details |
| POST | /create-novelty-change-names-dependent | Create novelty change names dependent | View details |
| POST | /bulk-upload-novelty-dependent | Bulk upload novelty dependent | View details |
| GET | /obtain-novelty-recent-worker-dependent | Obtain novelty recent worker dependent | View details |
| GET | /obtain-files-send-by-dates-ranges-dependent | Obtain files send by dates ranges dependent | View details |
| GET | /obtain-contracts-for-retired-independent-worker | Obtain contracts for retired independent worker | View details |
| GET | /obtain-novelty-bulk-pending-filing-dependent | Obtain novelty bulk pending filing dependent | View details |
| GET | /obtain-ats-without-filing-dependent | Obtain ats without filing dependent | View details |
| GET | /obtain-support-affiliate-dependent | Obtain support affiliate dependent | View details |
| GET | /obtain-accidents-filed-company-uptodate-dependent | Obtain accidents filed company up to date dependent | View details |
| POST | /obtain-support-affiliate-independent-massive-internal | Obtain support affiliate independent massive internal | View details |
| GET | /obtain-diagnoses | Obtain diagnoses | View details |
| GET | /obtain-diagnosed-by | Obtain diagnosed by | View details |
| GET | /obtain/registration/control/massive/report/affiliation | Obtain registration control massive report affiliation | View details |
| POST | /reprocess-massive-new | Reprocess massive new | View details |
| POST | /reprocess-massive-news-pending-filing | Reprocess massive news pending filing | View details |
| POST | /customers/identity-data | Customer identity data | View details |
| POST | /obtain-support-affiliate-independent-massive | Obtain support affiliate independent massive | View details |
| GET | /independent-workers-coverage | Independent workers coverage | View details |
| GET | /worker-salary | Worker salary | View details |
| GET | /create-new-change-salary-dependent | Create new change salary dependent | View details |
| GET | /obtain-contract-type | Obtain contract type | View details |
| GET | /obtain-novelties-bulk-pending-filing-dependent | Obtain novelties bulk pending filing dependent | View details |
| GET | /obtain-novelties-bulk-successful-filed-dependent | Obtain novelty bulk successfully filed dependent | View details |
| GET | /obtain-successful-income-file-independent | Obtain successful income file independent | View details |
| GET | /obtain-wrong-income-file-independent | Obtain wrong income file independent | View details |
| GET | /check-status-process-generation-support-affiliation | Check status process generation support affiliation | View details |
| GET | /create-new-identification | Create new identification | View details |
| GET | /work-center-table-support-by-company | Work center table support by company | View details |
| GET | /types-news-headquarters | Types news headquarters | View details |
| GET | /support-novelty-headquarters-change-telephone | Support novelty headquarters change telephone | View details |
| GET | /support-news-headquarters-change-address | Support news headquarters change address | View details |
| GET | /support-novelty-headquarters-change-fax | Support novelty headquarters change fax | View details |
| DELETE | /remove-record-control-massive-affiliation | Remove Record Control Massive Affiliation | View details |
| PUT | /update-company | Update company | View details |
| GET | /obtain-configuration-parameter | Obtain configuration parameter | View details |
| GET | /validate-user-registration-business-group | Validate user registration business group | View details |
| GET | /obtain-work-center-approval-report | Obtain work center approval report | View details |
| GET | /obtain-applications-company-work-centers | Obtain applications company work centers | View details |
| PUT | /update-data-company-resolution-ugpp | Update Data Company Resolution UGPP | View details |
| GET | /obtain-independent-worker-by-consecutive-worker | Obtain independent worker by consecutive worker | View details |
| POST | /disallow-product-by-contract | Disallow product by contract | View details |
| POST | /disallow-product-by-massive-contract | Disallow product by massive contract | View details |
| GET | /obtain-independent-worker-data | Obtain independent worker data | View details |
| POST | /obtain-headquarters-with-responsible-apolo | Obtain headquarters with responsible apolo | View details |
| POST | /obtain-access-to-hive-management | Get Access to Hive Management | View details |
| DELETE | /remove-product-by-contract | Delete Product by contract | View details |
| DELETE | /remove-exceptions-from-news-for-the-company | Delete exceptions from news for the company | View details |
| GET | /user-validation-complies-with-business-rules | User validation complies with business rules | View details |
| GET | /contract-exceptions-news | Contract exceptions news | View details |
| GET | /obtain-closing-period-of-operations | Obtain closing period of operations | View details |
| GET | /obtain-list-of-unlegalized-accidents | Obtain list of unlegalized accidents | View details |
| POST | /allow-product-by-contract | Allow product by contract | View details |
| POST | /allow-product-by-massive-contract | Allow product by massive contract | View details |
| POST | /save-contacts | Save contacts | View details |
| GET | /create-new-closing-work-center-with-workers | Create new closing work center with workers | View details |
| GET | /create-retroactive-closing-period | Create retroactive closing period | View details |
| POST | /establish-user-permissions/colmena-gestion | Establish User Permissions In Colmena Gestión | View details |
| GET | /obtain-user/colmena-gestion | Get user colmena gestión | View details |
| GET | /obtain-detail-application-center-work | Obtain detail application center-work | View details |
| PUT | /update-novelty-massive-independent-pending | Update Novelty Massive Independent Pending | View details |
| GET | /obtain-company | Obtain company | View details |
| POST | /create-request-new-work-center-company | Create request new work center company | View details |
| PUT | /update-novelty-massive-dependent-filing-pending | Update Novelty Massive Independent Filing Pending | View details |
| POST | /create-novelty-change-basic-data-center-work | Create novelty change basic data center work | View details |
| POST | /create-novelty-closure-center-work | Create New Closure Center Work | View details |
| GET | /obtain-dependent-workers-By-WorkCenter | Obtain Dependent Workers by Work Center | View details |
| GET | /obtain-companies-holding-by-identification | Obtain Companies Holding By Identification | View details |
| POST | /create-novelty-change-work-center-dependents | Create novelty change work center dependents | View details |
| GET | /obtain-paid-returns | Obtain Paid Returns | View details |
| GET | /obtain-indicatives-by-state | Obtain indicatives by state | View details |
| GET | /obtain-contacts | Obtain contacts | View details |
| POST | /independent-work-accident | Independent work accident | View details |
| GET | /obtain-main-headquarter | Obtain main headquarter | View details |
| POST | /obtain-cards-dependent-identification | Obtain cards dependent identification | View details |
| GET | /obtain-optional-report-fields | Obtain optional report fields | View details |
| GET | /obtain-products | Obtain products | View details |
| GET | /obtain-regional | Obtain regional | View details |
| GET | /obtain-specific-business-types | Obtain specific business types | View details |
| GET | /obtain-branches-by-regional | Obtain branches by regional | View details |
| GET | /obtain-company-niches | Obtain company niches | View details |
| GET | /obtain-niches | Obtain niches | View details |
| GET | /obtain-contract-states | Obtain contract states | View details |
| GET | /obtain-economic-activities-by-niche | Obtain economic activities by niche | View details |
| PUT | /update-company-exceptions | Update company exceptions | View details |
| PUT | /update-job-center-creation-request-status | Update job center creation request status | View details |
| GET | /obtain-company-by-contract-number | Obtain company by contract number | View details |
| GET | /obtain-products-by-company | Obtain products by company | View details |
| GET | /obtain-company-not-linked-by-id | Obtain company not linked by ID | View details |
| POST | /obtain-companies-by-filters-for-authorization | Obtain companies by filters for authorization | View details |
| GET | /obtain-job-center-creation-request | Obtain job center creation request | View details |
| POST | /register-acceptance-terms-conditions-colmena-management | Register Acceptance Terms Conditions Colmena Management | View details |
| GET | /obtain-dependent-linker-types | Obtain dependent linker types | View details |
| PUT | /update-role-worker-colmena-management | Update role worker colmena management | View details |
| PUT | /update-closing-period-retro-active | Update closing period retro active | View details |
| POST | /establish-user-permissions-colmena-management | Establish User Permissions In Colmena Management | View details |
| GET | /obtain-embedded-information | Obtain embedded information | View details |
| POST | /power-bi-filters | POWER BI filters | View details |
| GET | /obtain-audit-report-colmena-gestion | Obtain audit report Colmena Gestion | View details |
| POST | /check-bulk-upload-status | Check bulk upload status | View details |
| POST | /bulk-upload-novelty-dependent-background | Bulk upload new dependent background | View details |
| POST | /bulk-upload-novelty-independent-background | Bulk upload new dependent background | View details |
| GET | /obtain-attachments-by-type-process | Obtain attachments by type process | View details |
| GET | /obtain-accident-reports-independent-company-up-to-date | Obtain accident reports independent company up to date | View details |
| GET | /obtain-report-rosette | Obtain report rosette | View details |
| GET | /obtain-events-by-person | Obtain events by person | View details |
| GET | /obtain-certified-report | Obtain-certified-report | View details |
| GET | /obtain-products-by-contract | Obtain products by contract | View details |
| POST | /obtain-cards-independent-identification | Obtain cards independent identification | View details |
| GET | /obtain-novelty-bulk-pending-filing-independent | Obtain novelty bulk pending filing dependent | View details |
| GET | /contract-states | Contract states | View details |
| GET | /obtain-card-report-records | Get obtain card report records | View details |
| GET | /generation-certificate-payment-of-disabilities | Generation of Disability Payment Certificate | View details |
| GET | /consult-card-cover | Consult card cover | View details |
| GET | /v1/get-company-workers | Get information from workers | View details |
| GET | /v1/get-company-worker-centers | Obtain information from the company's work centers | View details |
| PUT | /inovice-reserve-headers | Invoice reserve headers | View details |
| PUT | /invoice-reserve-details | Invoice reserve details | View details |
| DELETE | /remove-user-colmena-management | Removes the permissions of the user in Colmena gestion | View details |
| GET | /get-disability-payments | Generation of disability payments | View details |
📤 Example Request (Generic)
curl -X GET "https://cs-apolo2-sapi-v1-dev.us-e1.cloudhub.io/api/[example-endpoint]" \
-H "client_id: YOUR_CLIENT_ID" \
-H "invoker: { \"application\": \"Portal\",\"addressIPUser\": \"192.168.80.13\",\"loginUser\": \"User\",\"userName\": \"User Name\" }"⚠️ 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