Cotizantes Sandbox

El API cotizantes lite utiliza las siguientes cabeceras para su uso:

• app_id: Es un código generado por Nubloq para la identificación de quién esté haciendo uso de la API.

Solicitud

Una vez se entregan las credenciales por parte de Nubloq, se pueden ejecutar las peticiones mediante llamados POST. Para ello, se usan los siguientes parámetros:

• URL de la petición: 'https://apim-prod-data.nubloq.app/v2/sandbox/cotizantes'

• Tipo de método: 'POST'

Respuestas

Las respuestas que se pueden obtener según sea el caso son las siguientes, todas son tipo JSON:

POST https://apim-prod-data.nubloq.app/v2/sandbox/cotizantes

Headers

Name	Type	Description
app_id*	String	{app_id}
Authorization*	String	{token_type} {access_token}

Request Body

Name	Type	Description
tipo_documento*	String	CC
num_documento*	String	8968132799

200: OK Esta respuesta se da cuando el usuario es encontrado en nuestros registros de manera exitosa.

{
    "status": true,
    "message": null,
    "requestID": "34da5ab...",
    "tipoDocumento": "CC",
    "numeroDocumento": "8968132799",
    "primerNombre": "ANGIE",
    "segundoNombre": "ESTEBAN",
    "primerApellido": "MORENO",
    "segundoApellido": "MUÑETON",
    "periodos": [
        {
            "periodoCotizacion": "202204",
            "tipoPlanilla": "E",
            "descTipoPlanilla": "Empleados",
            "tipoCotizante": "1",
            "descTipoCotizante": "Dependiente",
            "idAdminEPS": "",
            "nombreAdminEPS": "",
            "ibcEPS": "0",
            "idAdminARL": "14-11",
            "nombreAdminARL": "ARL SURA",
            "ibcARL": "1860000",
            "idAdminCCF": "",
            "nombreAdminCCF": "",
            "ibcCCF": "0",
            "idAdminPension": "",
            "nombreAdminPension": "",
            "ibcPension": "0",
            "salarioBasico": "1860000",
            "tipoDocumentoAportante": "NI",
            "numeroDocumentoAportante": "978564873",
            "empresa": "MEDICADOS LTDA",
            "novedadIngreso": "X",
            "novedadRetiro": "",
            "licenciaNoRemunerada": "5",
            "pagoPilaAlDia": "NO"
        },
        {
            "periodoCotizacion": "202203",
            "tipoPlanilla": "E",
            "descTipoPlanilla": "Empleados",
            "tipoCotizante": "1",
            "descTipoCotizante": "Dependiente",
            "idAdminEPS": "",
            "nombreAdminEPS": "",
            "ibcEPS": "0",
            "idAdminARL": "14-11",
            "nombreAdminARL": "ARL SURA",
            "ibcARL": "980000",
            "idAdminCCF": "",
            "nombreAdminCCF": "",
            "ibcCCF": "0",
            "idAdminPension": "",
            "nombreAdminPension": "",
            "ibcPension": "0",
            "salarioBasico": "980000",
            "tipoDocumentoAportante": "NI",
            "numeroDocumentoAportante": "860511917",
            "empresa": "IMPORHONDA LTDA",
            "novedadIngreso": "",
            "novedadRetiro": "X",
            "licenciaNoRemunerada": "8",
            "pagoPilaAlDia": "NO"
        }
    ]
}

400: Bad Request Esta respuesta se da cuando el cuerpo y los encabezados de la petición están mal formados.

{
    "status": false,
    "requestID": null,
    "message": "Bad request"
}

401: Unauthorized Esta respuesta se da cuando falta el encabezado “Authorization” o tiene un valor no válido.

{
    "statusCode": 401,
    "message": "Unauthorized. Access token is missing or invalid."
}

403: Forbidden Esta respuesta se da cuando el usuario no está autorizado para consumir el servicio.

{
    "status": false,
    "requestID": “9138c6a3-...”,
    "message": "Acceso no autorizado!."
}

404: Not Found Esta respuesta se da cuando el usuario no existe en nuestros registros.

{
    "status": false,
    "requestID": "9138c6a3-...",
    "message": "Usuario no encontrado."
}

500: Internal Server Error Esta respuesta se da cuando ocurre una excepción no controlada.

{
    "status": false,
    "requestID": "9138c6a3-...",
    "message": "Internal server error."
}

Nota: Se debe informar a Nubloq el listado de las direcciones IP que van a consumir el servicio, para así proceder a otorgar los permisos necesarios.

Para el campo “tipo_documento” los valores válidos son los siguientes (se debe ingresar el campo nomenclatura):

Nomenclatura	Tipo De Documento
CC	Cédula de Ciudadanía
PE	Permiso Especial
TI	Tarjeta De Identidad
SC	Salvoconducto De Permanencia
RC	Registro Civil
PA	Pasaporte
CE	Cédula Extranjería
CD	Carné Diplomático

curl --location 'https://https://apim-prod-data.nubloq.app/v2/sandbox/cotizantes' \
--header 'app_id: {app_id}' \
--header 'Authorization: {token_type} {access_token}' \
--header 'Content-Type: application/json' \
--data '{     
    "tipo_documento": "CC",     
    "num_documento": "90000009"
} '