isolucion Data Connector      

6.0.26.06.19.25
  • Accionista
  • Actividad Economica
  • Area
  • Ausentismo
  • Cargo
  • Centros de costo
  • Cliente
  • Ciudad
  • Debida diligencia Laft
  • 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
  • Riesgo de producto
  • Roles de usuario
  • SLF Canal
  • Sucursales
  • Tercero
  • Tipo Acción
  • Tipo contraparte
  • Tipo De Relación
  • Tipo Documento
  • Tipo Identificación
  • Tipo Producto
  • Tipo Persona
  • Tipo Problema
  • Usuario

  • Obtener
  • Obtener Productos por Proceso
  • Crear
  • Actualizar por Nombre

PRODUCTOS Request information


Obtiene la lista de productos existentes en el sistema ISOLUCIÓN.


URI parameters

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

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


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.

Query string parameters


Si requiere paginar los registros se deben enviar estos parametros por query string.

HTTP GET: https://[service_address]/api/[metodo]?RegistroActual=0&TamanoPagina=20

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

[metodo]: Hace referencia al objeto de isolucion que queremos consultar (Funcionarios, Mediciones, Cargos, etc).


Nombre del campo Formato Tamaño Descripción Obligatorio
RegistroActual Númerico Indice del registro en el cual se encuentra la consulta. Indice inicial debe ser 0. Si.
TamanoPagina Númerico Cantidad total de registros que se quiere traer. Si el tamaño es 0 se consultaran todos los datos Si.

Productos 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,500] Exito,Error.
Message "Message":"Lista de Productos obtenida exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [[{data1},{data2}...],null] Formato JSON con el listado de Productos registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
"StatusCode": 200,
"Message": "Lista de productos obtenida exitosamente.",
"Entity": "[{\"IdProducto\":1,\"IdProceso\":0,\"NomProducto\":\"Calibración y Mantenimiento servicios\"},{\"IdProducto\":2,\"IdProceso\":0,\"NomProducto\":\"CARACTERISTICAS DE EMBALAJE\"},{\"IdProducto\":3,\"IdProceso\":0,\"NomProducto\":\"EXTRACCION DE MADERA\"},{\"IdProducto\":4,\"IdProceso\":0,\"NomProducto\":\"Nuevo servicio\"}]"
        }

Sample ERROR Response:

{
    "StatusCode": 401,
    "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
    "Entity": null
}
{
    "StatusCode": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}

PRODUCTOS Request information


Obtiene la lista de productos por proceso.


URI parameters

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

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

[IdProceso]: Identificador del proceso del que se quiere obtener.


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.

Body parameters

Nombre del campo Formato Tamaño Descripción Obligatorio
IdProceso Entero Id del Proceso. Si.

Request Formats

application/json/

Sample:

{ "IdProceso" : 2}

PRODUCTOS 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,500] Exito,Error.
Message "Message":"Lista de productos obtenida exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [[{data1},{data2}...],null] Formato JSON con el listado de PRODUCTOS registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
"StatusCode": 200,
"Message": "Lista de PRODUCTOS obtenida exitosamente.",
"Entity": "[[{\"IdProducto\":1,\"IdProceso\":2,\"NomProducto\":\"producto 1\"}]]"
        }

Sample ERROR Response:

{
    "StatusCode": 401,
    "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
    "Entity": null
}
{
    "StatusCode": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}

PRODUCTOS Request information


Crea un producto en el sistema ISOLUCIÓN a través de esta opción.


URI parameters

HTTP POST: https://[service_address]/api/Producto/Crear

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


POST 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

Nombre del campo Formato Tamaño Descripción Obligatorio
NomProducto Texto varchar(100) Nombre del producto. Debe ser único, no puede existir previamente. Si.
CodTipoProducto Entero int Identificador del tipo de producto al que pertenece. (Ver métodos Tipo Producto) No.
Activo Booleano [1,0] Activo:1 , Inactivo:0. Indica si el producto se encuentra activo o no. No.
EsNivelGlobal Entero int Indica si el producto es de nivel global (1) o pertenece a alguna sucursal (0). Si (Para empresas con multicompañia).
Sucursales Texto varchar(255) Lista de sucursales a las que pertenece el producto. Si (Para empresas con multicompañia).

Request Formats

application/json/

Sample:

{"NomProducto":"Mi Nuevo Producto ERP", "CodTipoProducto":3, "Activo":1, "EsNivelGlobal":1, "Sucursales":"1"}

PRODUCTOS Response Information


Resource Description

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


Response Formats

application/json/
Campo Ejemplo Descripción
StatusCode "StatusCode":201 Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [201,400,500] Exito,Error.
Message "Message":" Producto creado exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [[{data1},{data2}...],null] Formato JSON con los datos creados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample OK Response:

{
"StatusCode": 201,
"Message": "Producto creado exitosamente.",
"Entity": "{\"IdProducto\":25,\"IdProceso\":0,\"NomProducto\":\"Mi Nuevo Producto ERP\",\"CodTipoProducto\":3,\"Activo\":true,\"EsNivelGlobal\":1,\"Sucursales\":\"1\"}"
}

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": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}

PRODUCTOS Request information


Actualiza un producto en el sistema ISOLUCIÓN a través de esta opción.


URI parameters

HTTP PUT: https://[service_address]/api/Producto/Actualizar

[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

Nombre del campo Formato Tamaño Descripción Obligatorio
NomProducto Texto varchar(100) Nombre del producto. Usado para la búsqueda y actualización. Si.
CodTipoProducto Entero int Identificador del tipo de producto al que pertenece. (Ver métodos Tipo Producto) No.
Activo Booleano [1,0] Activo:1 , Inactivo:0. Indica si el producto se encuentra activo o no. No.
EsNivelGlobal Entero int Indica si el producto es de nivel global (1) o pertenece a alguna sucursal (0). Si (Para empresas con multicompañia).
Sucursales Texto varchar(255) Lista de sucursales a las que pertenece el producto. Si (Para empresas con multicompañia).

Request Formats

application/json/

Sample:

{"NomProducto":"Mi Nuevo Producto ERP", "CodTipoProducto":3, "Activo":0, "EsNivelGlobal":0, "Sucursales":"1"}

PRODUCTOS 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":" Producto actualizado exitosamente." Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [[{data1},{data2}...],null] 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": "Producto actualizado exitosamente.",
"Entity": "{\"IdProducto\":25,\"IdProceso\":0,\"NomProducto\":\"Mi Nuevo Producto ERP\",\"CodTipoProducto\":3,\"Activo\":false,\"EsNivelGlobal\":0,\"Sucursales\":\"1\"}"
}

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
}