Documentación Nubloq (1.0)

Download OpenAPI specification:Download

Si necesitas soporte, puedes contactarte con: soporte@nubloq.co License: Apache 2.0 Terms of Service

Introducción

En Nubloq podrás encontrar los productos financieros que tu equipo necesita para crecer; contamos con soluciones de finanzas embebidas que extienden la oferta de tu compañía.

Aunque aún estamos en beta privado, este documento podrás consultar la definición y los endpoints de conexión que necesitas para poder realizar la integración de los productos que tenemos hasta el día de hoy. Las APIs de Nubloq están diseñadas bajo el modelo REST (REpresentational State Transfer), uno de los modelos mayormente usados en la creación de APIs, de manera que se puede garantizar un modelo estándar para el uso de los recursos.

Ambientes

Contamos con dos ambientes para realizar tu proceso de integración:

Ambientes Descripción URL
Sandbox Es un ambiente dedicado al desarrollo de tu aplicación, en el se pueden realizar pruebas tendientes a corroborar la idoneidad de tu producto, con datos que no afectarán el funcionamiento del servicio. https://sandbox.nubloq.co/
Producción Es un ambiente concebido para el despliegue de la aplicación final, para que sea funcional, se deben usar credenciales reales que permitan la comunicación con la institución. https://api.nubloq.co/

Autenticación

El mecanismo de autenticación en Nubloq tiene dos elementos: Client credentials y uso de certificados para la autenticación del servidor. Podrás acceder a ambas credenciales desde el portal de desarrollador. Si tienes inquietudes en el mecanismo de integración del certificado, por favor contáctanos en soporte@nubloq.co .

  • Client ID: Es un código que identifica la aplicación que se conecta al servicio, permite al sistema conocer quién está haciendo uso de la plataforma.
  • Client Secret: Es un código de acceso a la plataforma, permite validar que las credenciales sean válidas para garantizar la seguridad en el sistema.
  • Certificados Mutual TLS: Es un modelo de autenticación en donde dos partes involucras confirman entre sí su identidad; aumentando la seguridad de la comunicación. La plataforma genera un archivo en formato .PEM.

Obtención de credenciales

Los pasos para obtener las credenciales son los siguientes: Una vez se entregue el Client Secret por parte de Nubloq, se pueden solicitar los "client_credentials" mediante una petición POST; para ello se usan los siguientes parámetros:

  • URL para realizar la petición: '{API Gateway host}/oauth/access-token'
  • Tipo de método para la petición: 'POST'

Los parámetros de la cabecera (header) en para obtener la petición son:

Clave (Key) Valor (Value)
Authorization Basic {clientid:clientsecret codificado en Base64}
Content-Type application/json

Nota: El valor de la cadena Authorization comienza con el string "Basic" seguido de un espacio, finalmente el Client Secret entregada en formato Base64. La respuesta de esta petición será una cadena en formato JSON como la siguiente:

  {
    "access_token": "27aafb5e-34a2-3ae4-59ac-16b11832e3c9",
    "token_type": "access_token",
    "expires_in": 3600
  }

El valor dado en "access_token" será el que se use en la API para realizar las consultas necesarias.

Datos

Datos de contribuyentes, consulta POST

Obtiene información de contribuyentes

Authorizations:
header Parameters
client_id
string <uuid>
access_token
string <uuid>
Request Body schema: application/json
id
string <uuid>
tipoDocumento
string
Value: "IdentityCardNumber"
personIdentificationNumber
integer [ 1 .. 99999999 ]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tipoDocumento": "IdentityCardNumber",
  • "personIdentificationNumber": 1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "givenName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "surname": "string",
  • "gender": "male",
  • "birthDate": "2019-08-24",
  • "nationality": {
    },
  • "identification": {
    },
  • "civilStatus": "string",
  • "profession": "string",
  • "postalAddress": {
    },
  • "electronicAddress": {
    },
  • "phoneAddress": {
    },
  • "socialNetworkAddress": {
    },
  • "contributor": {
    }
}

Seguros

En esta sección podrás encontrar la información relacionada con los productos de seguros disponibles actualmente en Nubloq: Accidentes Personales (Sandbox y Producción).

Accidentes personales Expedition

Obtiene información de seguros correspondiente al producto de accidentes personales.

Authorizations:
header Parameters
client_id
string <uuid>
access_token
string <uuid>
Request Body schema: application/json
object
Array of objects (beneficiary)
object

Responses

Request samples

Content type
application/json
{
  • "insured": {
    },
  • "beneficiary": [
    ],
  • "insurancePolicyInformation": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "premiumInsurance": 1,
  • "netPremiumInsurance": 9999999,
  • "taxes": 9999999,
  • "policyNumber": "string",
  • "businessNumber": "string",
  • "result": "string",
  • "errors": "string",
  • "message": "string"
}

Catálogos

Aquí podrás encontrar información sobre instituciones, productos, y otros catálogos específicos para la integración de nuestras API.

Catálogos

Obtiene la información específica para los catálogos.

path Parameters
productId
required
string
header Parameters
client_id
string <uuid>
access_token
string <uuid>
Request Body schema: application/json
id
string <uuid>
catalogName
string
Enum: "valor_asegurado" "genero" "periodicidad_pago" "tipo_documento_tomador" "pais_nacimiento" "tomador_PEP" "ciudad" "parentesco_PEP" "parentesco_beneficiario" "relacion_socio" "tipo_documento_PEP" "GRUPO"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "catalogName": "valor_asegurado"
}

Response samples

Content type
application/json
[
  • "stringst"
]

Organizaciones

Obtiene la lista de todas las organizaciones soportadas por Nubloq.

header Parameters
client_id
string <uuid>
access_token
string <uuid>

Responses

Request samples

curl -i -X POST \
  https://sandbox.nubloq.co/catalogs/v1/organizations \
  -H 'access_token: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'client_id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Response samples

Content type
application/json
[
  • {
    }
]

Productos

Obtiene la lista de todas las organizaciones soportadas por Nubloq.

path Parameters
organizationId
required
string
header Parameters
client_id
string <uuid>
access_token
string <uuid>

Responses

Request samples

curl -i -X POST \
  'https://sandbox.nubloq.co/catalogs/v1/{organizationID}/products' \
  -H 'access_token: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'client_id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productId": "string",
  • "productType": "string"
}