isolucion Data Connector      

6.0.25.06.20.25
  • Accionista
  • Actividad Economica
  • Area
  • Ausentismo
  • Cargo
  • Centros de costo
  • Cliente
  • Ciudad
  • Denuncia
  • Departamentos
  • Documento
  • Equipo
  • Familia
  • Financiera
  • Funcionarios
  • Furat
  • Furel
  • Furil
  • Grupos
  • Grupo Usuario
  • Indicador
  • Información Financiera
  • Listado Maestro
  • Medición
  • Objetivo
  • Oficina
  • Origen Recursos
  • Pais
  • Plantilla documental
  • PQR
  • Proceso
  • Productos
  • Proveedores
  • Registros
  • Roles de usuario
  • SLF Canal
  • Sucursales
  • Tercero
  • Tipo Acción
  • Tipo De Relación
  • Tipo Documento
  • Tipo Identificación
  • Tipo Persona
  • Tipo Problema
  • Usuario

  • Obtener documento por ID
  • Obtener por URL
  • Obtener documentos por Ids

DOCUMENTO Request information


Obtiene el contenido (array de bytes) de un documento segun su identificador en ISOLUCIÓN.


URI parameters

HTTP GET: https://[service_address]/api/documento/{id}

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.

[id]:Identificador del documento del cual se quiere obtener su contenido.


GET Request HTTP Headers


Header Ejemplo Descripción
Authorization Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración.

Una vez creado el usuario se debe cifrar en base64 de la siguiente manera

NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Referencias
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

DOCUMENTO Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.


Response Formats

application/json/
Campo Ejemplo Descripción
StatusCode "StatusCode":200 Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error.
Message "Message":"Documento obtenido exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [] Formato JSON con el listado de roles de usuario registradas en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample OK Response:

{
"StatusCode": 200,
"Message": "Documento obtenido exitosamente..",
"Entity": "[documento arreglo bytes]"
}

Sample ERROR Response:

{
    "StatusCode": 400,
    "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.",
    "Entity": null
}
{
    "StatusCode": 401,
    "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
    "Entity": null
}
{
    "StatusCode": 404,
    "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.",
    "Entity": null
}
{
    "StatusCode": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}

DOCUMENTO Request information


Obtiene el contenido (array de bytes) de un documento por URL.


URI parameters

HTTP GET: https://[service_address]/api/documento

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.


PUT Request HTTP Headers


Header Ejemplo Descripción
Authorization Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración.

Una vez creado el usuario se debe cifrar en base64 de la siguiente manera

NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Referencias
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

Body parameters

Formato Tipo Descripción Obligatorio
Texto Ruta del documento dentro de isolucion. Si.

Request Formats

application/json/

Sample:

[]

Documento Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de actualización en el sistema.


Response Formats

application/json/
Campo Ejemplo Descripción
StatusCode "StatusCode":200 Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error.
Message "Message":" Documento obtenido exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [] Formato JSON con los datos actualizados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample OK Response:

{
"StatusCode": 200,
"Message": "Documento obtenido exitosamente.",
"Entity": "[]"
}

Sample ERROR Response:

{
    "StatusCode": 400,
    "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.",
    "Entity": null
}
{
    "StatusCode": 401,
    "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
    "Entity": null
}
{
    "StatusCode": 404,
    "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.",
    "Entity": null
}
{
    "StatusCode": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}

DOCUMENTO Request information


Obtiene el contenido (array de bytes) de un zip de los documentos segun su identificador en ISOLUCIÓN.


URI parameters

HTTP GET: https://[service_address]/api/documentolista/{ids}

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.

[id]:Identificadores de los documentos de los cual se quiere obtener su contenido, seprado por comas 12,14.


GET Request HTTP Headers


Header Ejemplo Descripción
Authorization Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración.

Una vez creado el usuario se debe cifrar en base64 de la siguiente manera

NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==

Referencias
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

DOCUMENTO Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.


Response Formats

application/json/
Campo Ejemplo Descripción
StatusCode "StatusCode":200 Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error.
Message "Message":"Documento obtenido exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": []

Sample OK Response:

{
"StatusCode": 200,
"Message": "Documento obtenido exitosamente..",
"Entity": "[documento arreglo bytes]"
}

Sample ERROR Response:

{
    "StatusCode": 400,
    "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.",
    "Entity": null
}
{
    "StatusCode": 401,
    "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
    "Entity": null
}
{
    "StatusCode": 404,
    "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.",
    "Entity": null
}
{
    "StatusCode": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}