SCRIPTSI

SCRIPT, SERVICIOS EN INFORMÁTICA

Inicio Productos Servicios Contacto

API bidireccional para conectar inventarios externos a SVISION

Información General

SSI-API para conectar inventarios externos a SVISION consta de 7 EndPoints (subprocesos) divididos en 2 procesos principales:

Carga de repuestos, vales y consumos
1. Método POST. Envía la información a insertar o actualizar de los repuestos por almacén.
2. Método GET. Recupera la información de los vales con estado: por surtir o surtido parcial en SVISION.
3. Método POST. Se utiliza para enviar el surtido (entrega) de los repuestos solicitados en los vales entregados por el subproceso anterior.
4. Método GET. Recupera los consumos de repuestos registrados en el SVISION.
5. Método GET. Recupera los vales cerrados con repuestos marcados sin consumir y puestos como devueltos en el API.
6. Método POST. Reporta la recepción de los repuestos devueltos en el inventario externo al API.
Flujo de repuestos para hoja de demanda
1. Método GET. Recupera las cantidades de repuestos asignados a actividades programadas de mantenimiento preventivo en SVISION.

El API mantiene conexión en línea con la BD de SVISION, actualizando y recuperando la información que se recibe o entrega en cada EndPoint. La llamada o implementación de cada EndPoint en el inventario externo tendrá que desarrollarse por los implementadores / desarrolladores de cada ERP. En nuestra experiencia es un desarrollo que les ha tomado, con los cliente que ya usan el API, entre 4 y 5 semanas.

Documentación

Método: POST. Tipo de autorización: API Key

URL de ejemplo: https://api.com.mx:9745/api/SetRptosAlm?val1=QQdsx790xW01%97lKg)

Descripción: Inserta y/o actualiza los repuestos de inventarios externos, por almacén, en una base de datos de inventario SVISION.

Parámetro	Tipo	Longitud	Requerido	Descripción
Almacen	Objeto JSON		Si	Recibe una cadena con formato Object-JSON con los datos del almacén y sus repuestos a cargar / actualizar en SVISION (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
CveAlmacen	Texto	25	Si	Recibe el valor de la clave que identifica al almacén en el inventario externo. Debe ser un valor único, indistinto para mayúsculas y minúsculas.
Descripcion	Texto	60	No	Recibe el nombre o descripción con la que se identifica al almacén en el inventario externo.
Encargado	Texto	60	No	Recibe el nombre de la persona o entidad encargada del almacén.
Ubicacion	Texto	255	No	Recibe el domicilio o localización del almacén.
Rptos	Lista (Array)		Si	Recibe lista de repuestos a cargar o actualizar en SVISON con formato JSON String (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdUnico	Texto	100	Si	Recibe el valor del identificador único del repuesto en el sistema del inventario externo, indistinto para mayúsculas y minúsculas.
NumParte	Texto	20	Si	Recibe el número de parte / código del repuesto.
Descripcion	Texto	140	Si	Recibe el nombre / descripción del repuesto.
UnidadM	Texto	8	Si	Recibe la unidad de medida para el repuesto. Distingue entre mayúsculas y minúsculas, por ejemplo: Kg es diferente a KG, por lo tanto, se registrará como unidades distintas cada una.
CostoUni	Decimal	14, 4	Si	Recibe el costo unitario del repuesto.
Existencia	Decimal	14, 4	Si	Recibe la existencia actual del repuesto en el almacén.
Localizacion	Texto	60	No	Recibe el valor del anaquel, lugar, ubicación, localización etc. Del repuesto dentro del almacén.
NivelMax	Decimal	14, 4	No	Recibe la cantidad máxima asignado al repuesto que podría haber en el almacén
NivelMin	Decimal	14, 4	No	Recibe la cantidad mínima que debería haber en el almacén.
NivelOpt	Decimal	14, 4	No	Recibe la cantidad optima del repuesto en el almacén.
Clasif1	Texto	50	No	Recibe la descripción de la primera clasificación, agrupación etc. Asignada al repuesto.
Clasif2	Texto	50	No	Recibe la descripción de la segunda clasificación, agrupación etc. Asignada al repuesto.
Activo	Entero	1	Si	Recibe la indicación si el repuesto es operable o no. Activo = 1 = es operable y Activo = 0 = no es operable.

Ejemplo de la cadena del parámetro de entrada a enviar en el body del EndPoint

“{\"Almacen\":{\"CveAlmacen\":\"ALM-MX\",\"Descripcion\":\"Almacén Ciudad de México\",\"Encargado\":\"Julio Lopez\", \"Ubicación\":\"Parque industrial Querétaro\",\"Rptos\":[{\"IdUnico\":\"00001\",\"NumParte\":\"01-01-0001\",\"Descripcion\":\"BANDA DE DISTRIBUCION 1x5\",\"UnidadM\":\"PZA\",\"CostoUni\":\"420.6500\",\"Existencia\":\"782.0000\",\"Localización\":\"ANAQUEL A2\", \"NivelMax\":\"1000\",\"NivelMin\":\"500\",\"NivelOpt\":\"800\",\"Clasif1\":\"BANDAS DENTADAS\",\"Clasif2\":\"PRODUCTO NACIONAL\",\"Activo\":\"1\"},{\"IdUnico\":\"00002\",\"NumParte\":\"01-01-0002\",\"Descripcion\":\"BANDA DE DISTRIBUCION 3x15\",\"UnidadM\":\"PZA\",\"CostoUni\":\"4.3452\",\"Existencia\":\"447\",\"Localizacion":"ANAQUEL B3\",\"NivelMax\":\"900\", \"NivelMin\":\"150\",\"NivelOpt\":\"500\",\"Clasif1\":\"BANDAS DENTADAS\",\"Clasif2\":\"PRODUCTO NACIONAL\",\"Activo\":\"1\"}]}}”

Método: GET. Tipo de autorización: API Key

URL de ejemplo: https://api.com.mx:9745/api/GetValXSurt?val1=QQdsx790xW01%97lKg)&cvealm=ALM-MX

Descripción: Recupera los vales de un almacén por surtir, asignados a las órdenes de trabajo de mantenimiento.

Parámetro	Tipo	Longitud	Requerido	Descripción
Vales	Lista (Array)		Si	Regresa una cadena con formato JSON de la lista de vales pendientes de surtir en SVISION (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdVale	Entero	9	Si	Regresa el valor único del identificar de cada vale para dar seguimiento al estado del vale y su atención.
CveAlmacen	Texto	25	Si	Regresa el identificador del almacén al que pertenece el vale, será el mismo valor que envió en la URL (En el ejemplo es cvealm).
Folio	Texto	15	Si	Regresa el folio asignado al vale al generarse desde el SVISION.
Fecha	Texto	10	Si	Regresa la fecha de creación asignada al vale con el formato: “aaaa-mm-dd”.
Estado	Texto	50	Si	Regresa el estado del vale: Por surtir o Surtido parcial.
Solicitante	Texto	400	Si	Regresa el nombre del solicitante de los repuestos del vale generado en SVISION.
Partidas	Lista (Array)		Si	Regresa una cadena con formato JSON de la lista de repuestos pendientes de surtir en SVISION (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdPartida	Entero	9	Si	Regresa el valor único por vale, del consecutivo de repuestos solicitados, inicia con valor 0 en cada vale.
IdUnico	Texto	100	Si	Regresa el identificador único del repuesto asignado en el sistema del inventario externo.
NumParte	Texto	20	Si	Regresa el número de parte / código del repuesto.
UnidadM	Texto	8	Si	Regresa la unidad de medida del repuesto.
CantPedida	Decimal	14, 4	Si	Regresa la cantidad solicitada del repuesto en la partida.
CantSurtida	Decimal	14, 4		Regresa la cantidad surtida del repuesto en la partida, es mayor a cero cuando el estado del vale es surtido parcial.
CantXSurtir	Decimal	14, 4		Regresa la cantidad que resta por surtir. Es el resultado de la resta: CantPedida – CantSurtida. El valor inicial es igual a CantPedida.
FolioOT	Texto	20		Regresa el folio de la orden de trabajo, cuando se asigna al vale.
Equipo	Texto	300		Regresa el nombre del equipo, cuando es asignado al vale.
Actividad	Texto	255		Regresa la descripción de la actividad programada en la orden de trabajo, cuando es asignada al vale.
TipoAct	Texto	50		Regresa la descripción del tipo de mantenimiento a realizar en la orden de trabajo, cuando es asignada al vale (preventivo, correctivo, etc.).
CenCosto	Texto	50		Regresa el centro de costo asignado al equipo, cuando es asociado al vale.

Ejemplo de la cadena JSON generada como resultado por el EndPoint

{"Vales":[{"IdVale":1,"CveAlmacen":"ALM-MX","Folio":"0000001","Fecha":"2022-09-05","Estado":"Por surtir","Solicitante":"Salomón Serrano Estrada","Partidas":[{"IdPartida":"0","IdUnico":"00001","NumParte":"01-01-0001","UnidadM":"PZA","CantPedida":"5.0000", "CantSurtida":"0.0000","CantXSurtir":"5.0000", "FolioOT":"OT00001","Equipo":"TRANSPORTADORA LINEA1","TipoAct":"Preventivo", "CenCosto":"065-200-21"},{"IdPartida":"1","IdUnico":"00002","NumParte":"01-01-0002", "UnidadM":"PZA","CantPedida":"6.0000", "CantSurtida":"0.0000","CantXSurtir":"6.0000", "FolioOT":"OT00001","Equipo":"TRANSPORTADORA LINEA2","TipoAct":"Correctivo", "CenCosto":"065-200-22"}]},{"IdVale":2,"CveAlmacen":"ALM-MX","Folio":"0000002","Fecha":"2022-09-05","Estado":"Surtido parcial", "Solicitante":"Luis Oscar Martinez Rojas","Partidas":[{"IdPartida":"0", "IdUnico":"00001","NumParte":"01-01-0001","UnidadM":"PZA", "CantPedida":"3.0000","CantSurtida":"0.0000","CantXSurtir":"3.0000","FolioOT":"OT00002","Equipo":"TRANSPORTADORA LINEA3", "TipoAct":"Preventivo","CenCosto":"065-200-41"},{"IdPartida":"1","IdUnico":"00002","NumParte":"01-01-0002","UnidadM":"PZA", "CantPedida":"5.0000","CantSurtida":"2.0000","CantXSurtir":"3.0000","FolioOT":"OT00002","Equipo":"TRANSPORTADORA LINEA4", "TipoAct":"Correctivo","CenCosto":"065-200-42"}]}]}

Método: GET. Tipo de autorización: API Key

URL de ejemplo: https://api.com.mx:9745/api/GetValXDev?val1=QQdsx790xW01%97lKg)&cvealm=ALM-MX

Descripción: Recupera los vales cerrados con repuestos sin consumir. Estos repuestos quedan marcados como devueltos en SVISION por el API.

Parámetro	Tipo	Longitud	Requerido	Descripción
ValesDev	Objeto JSON		Si	Regresa una lista con formato Object-JSON de los vales cerrados con repuestos sin consumir y marcados por el API para devolver (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdVale	Entero	9	Si	Regresa el valor único del identificar del vale cerrado en SVISION para dar seguimiento a la devolución.
CveAlmacen	Texto	25	Si	Regresa el identificador del almacén al que pertenece el vale que devuelve, será el mismo valor que se envió en el parámetro “cvealm” de la URL (En el ejemplo es ALM-MX).
Fecha	Texto	10	Si	Regresa la fecha en la que se generó el vale desde SVISON con el formato: “aaaa-mm-dd”.
Partidas	Lista (Array)		Si	Regresa una cadena con formato JSON de la lista de repuestos con cantidades por devolver al inventario externo (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdPartida	Entero	9	Si	Regresa el identificador único de la partida de los repuestos del vale por devolver.
IdUnico	Texto	100	Si	Regresa el identificador único del repuesto asignado en el sistema del inventario externo.
NumParte	Texto	20	Si	Regresa el número de parte / código del repuesto.
UnidadM	Texto	8	Si	Regresa la unidad de medida del repuesto.
CantXDev	Decimal	14, 4	Si	Regresa la cantidad del repuesto por devolver en la partida, que quedó sin consumir al cerrar el vale en SVISION.

Ejemplo de la cadena JSON generada como resultado por el EndPoint

{"ValesDev":[{"IdVale":1,"CveAlmacen":"ALM-MX","Folio":"0000001","Fecha":"2022-09-05","Partidas":[{"IdPartida":"0", "IdUnico":"00001","NumParte":"01-01-0001","UnidadM":"PZA", "CantSurtida":"5.0000","CantXDev":"2.0000"}, {"IdPartida":"1","IdUnico":"00002", "NumParte":"01-01-0002", "UnidadM":"PZA","CantSurtida":"6.0000","CantXDev":"1.0000"}]}, {"IdVale":2,"CveAlmacen":"ALM-MX", "Folio":"0000002","Fecha":"2022-09-05","Partidas":[{"IdPartida":"0", "IdUnico":"00001", "NumParte":"01-01-0001","UnidadM":"PZA", "CantSurtida":"3.0000","CantXDev":"3.0000",{"IdPartida":"1","IdUnico":"00002", "NumParte":"01-01-0002","UnidadM":"PZA","CantSurtida":"5.0000","CantXDev":"1.0000"}]}]}

Método: POST. Tipo de autorización: API Key

URL de ejemplo: https://api.com.mx:9745/api/SetDevVale?val1=QQdsx790xW01%97lKg)

Descripción: Recibe la devolución registrada en el inventario externo del vale de repuestos del almacén indicado.

Parámetro	Tipo	Longitud	Requerido	Descripción
ValesDevl	Objeto JSON		Si	Recibe formato Object-JSON del vale devuelto procesado en el inventario externo (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdVale	Entero	9	Si	Recibe el valor único del identificar del vale enviado en el EndPoint: “api/GetValXDev” para devolver repuestos.
CveAlmacen	Texto	25	Si	Recibe el identificador del almacén al que pertenece el vale que se devuelve.
Fecha	Texto	10	Si	Recibe la fecha en la que se generará el movimiento de devolución en el inventario externo,con formato: “aaaa-mm-dd”.
Partidas	Lista (Array)		Si	Recibe una cadena con formato JSON de la lista de repuestos devueltos en el inventario externo (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdPartida	Entero	9	Si	Recibe el identificador único de la partida de los repuestos del vale devuelto.
IdUnico	Texto	100	Si	Recibe el identificador único del repuesto asignado en el sistema del inventario externo.
NumParte	Texto	20	Si	Recibe el número de parte / código del repuesto.
UnidadM	Texto	8	Si	Recibe la unidad de medida del repuesto.
CantDev	Decimal	14, 4	Si	Recibe la cantidad del repuesto por devuelto en la partida, registrado en la devolución del inventario externo.

Ejemplo de la cadena del parámetro de entrada a enviar en el body del EndPoint

“{\"ValeDevl\":{\"IdVale\":1,\"CveAlmacen\":\"ALM-MX\",\"Fecha\":\"2022-09-08\",\"Partidas\":[ {\"IdPartida\":\"0\", \"IdUnico\":\"00001\",\"NumParte\":\"01-01-0001\",\"UnidadM\":\"PZA\",\"CantDev\":\"5.0000\"},{\"IdPartida\":\"1\", \"IdUnico\":\"00002\",\"NumParte\":\"01-01-0002\", \"UnidadM\":\"PZA\",\"CantDev\":\"6.0000\"}]}}”

Método: GET. Tipo de autorización: API Key

URL de ejemplo: https://api.com.mx:9745/api/GetConsumoR?val1=QQdsx790xW01%97lKg)&objPeriodo={“FechaIni”:”2022-09-01”,“FechaFin”:”2022-09-30”}

Descripción: Recupera los consumos de repuestos del periodo solicitado.

Parámetro	Tipo	Longitud	Requerido	Descripción
Consumos	Lista (Array)		Si	Regresa una lista con formato Object-JSON de los consumos de repuestos generados en SVISION (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdUnico	Texto	100	Si	Regresa el identificador único del repuesto asignado en el sistema del inventario externo y que se consumió en SVISION.
NumParte	Texto	20	Si	Regresa el número de parte / código del repuesto.
UnidadM	Texto	8	Si	Regresa la unidad de medida del repuesto.
Fecha	Texto	10	Si	Regresa la fecha del consumo con el formato: “aaaa-mm-dd”.
Catalog	Entero	1	Si	Regresa el Indicador si el repuesto está catalogado o no, es decir si el consumo pertenece a un repuesto ligado con el inventario externo. 1 = El repuesto consumido viene del inventario externo ligado a través del API. 0 = El repuesto consumido fue ingresado de forma manual en SVISION.
Cantidad	Decimal	14, 4	Si	Regresa la cantidad consumida en unidades del repuesto.
CostTot	Decimal	14, 4	Si	Regresa el costo total de la cantidad consumida del repuesto.
FolioOT	Texto	20	No	Regresa el folio de la orden de trabajo de ser asignada al consumo.
Equipo	Texto	300	No	Regresa el nombre del equipo de ser asignado al consumo.
Actividad	Texto	255	No	Regresa la descripción de la actividad de ser asignada al consumo.
TipoAct	Texto	50	No	Regresa la descripción del tipo de mantenimiento realizado en la orden de trabajo de ser asignada al consumo (preventivo, correctivo, etc.)
IdVale	Entero	9	No	Regresa el identificador único del vale de ser asignado al consumo.
CveAlmacen	Texto	25	No	Regresa el identificador del almacén al que pertenece el vale, de ser asignado al consumo.
FolioVale	Texto	15	No	Regresa el folio del vale de ser asignado al consumo.
CenCosto	Texto	50	No	Regresa el centro de costo de ser asignado al consumo.

Ejemplo de la cadena JSON generada como resultado del EndPoint

{"Consumos":[{"IdUnico":"00001","NumParte":"01-01-0001","UnidadM":"PZA","Fecha":"2022-09-06","Catalog":1,"Cantidad":"6.0000", "CostTot":"825.7500","FolioOT":" OT00001","Equipo":"TRANSPORTADORA LINEA1","Actividad":"Cambio de parte", "TipoAct":"Preventivo","IdVale":1,"CveAlmacen":"ALM-MX", "FolioVale":"0000001","CenCosto":"065-20078-21"}, {"IdUnico":"00002","NumParte":"01-01-0002", "UnidadM":"PZA","Fecha":"2022-09-06","Catalog":1,"Cantidad":"5.0000", "CostTot":"789.9000","FolioOT":" OT00002","Equipo":"TRANSPORTADORA LINEA2","Actividad":"Cambio de banda", "TipoAct":"Correctivo", "IdVale":2,"CveAlmacen":"ALM-MX","FolioVale":"0000002","CenCosto":"065-20080-31"}]}

Método: GET. Tipo de autorización: API Key

URL de ejemplo: https://api.com.mx:9745/api/GetRecuAsig?val1=QQdsx790xW01%97lKg)&objPeriodo={“FechaIni”:”2022-09-01”,“FechaFin”:”2022-09-30”}

Descripción: Recupera los repuestos asignados a actividades planificadas de mantenimiento del periodo solicitado, hasta por un año.

Parámetro	Tipo	Longitud	Requerido	Descripción
Rptos	Lista (Array)		Si	Regresa una lista con formato Object-JSON de los repuestos asociados en SVISION, a actividades preventivas del periodo indicado (Ver la siguiente tabla).

Parámetro	Tipo	Longitud	Requerido	Descripción
IdUnico	Texto	100	Si	Regresa el identificador único del repuesto asignado en el sistema del inventario externo.
NumParte	Texto	20	Si	Regresa el número de parte / código del repuesto.
UnidadM	Texto	8	Si	Regresa la unidad de medida del repuesto.
Fecha	Texto	10	Si	Regresa la fecha programada para realizar la actividad con el formato: “aaaa-mm-dd”.
Cantidad	Decimal	14, 4	Si	Regresa la cantidad requerida del repuesto para realizar la actividad programada en SVISION.
Equipo	Texto	300	Si	Regresa el nombre del equipo programado para mantenimiento.
Plan	Texto	60	Si	Regresa la descripción del plan de mantenimiento asignado al equipo.
Parte	Texto	1000	Si	Regresa la descripción de la parte del plan que contiene las actividades con asociación de repuestos.
Actividad	Texto	255	Si	Regresa la descripción de la actividad programada a realizar.
CenCosto	Texto	50	No	Regresa el centro de costo de ser asignado al equipo.
CodigoEqu	Texto	60	Si	Regresa el valor del código asignado al equipo en SVISION.
ClasifEqu1	Texto	60	No	Regresa la clasificación 1 de ser asignada al equipo en SVISION.
ClasifEqu2	Texto	60	No	Regresa la clasificación 2 de ser asignada al equipo en SVISION.

Ejemplo de la cadena JSON generada como resultado por el EndPoint

{"Rptos":[{"IdUnico":"00001","NumParte":"01-01-0001","UnidadM":"PZA","Fecha":"2022-10-28","Cantidad":"5.0000", "Equipo":"TRANSPORTADORA LINEA1","Plan":"MANTO. TRANSPORTADORAS","Parte":"\RODILLOS\","Actividad":"Cambio de Banda", "CenCosto":"CC-1259","CodigoEqu":"LG-789","ClasifEqu1":"Servicio","ClasifEqu2":"Merida"}, {"IdUnico":"00001","NumParte":"01-01-0001","UnidadM":"PZA","Fecha":"2022-10-28","Cantidad":"5.0000","Equipo":"TRANSPORTADORA LINEA2","Plan":"MANTO. TRANSPORTADORAS", "Parte":"\RODILLOS\","Actividad":"Cambio de Banda","CenCosto":"CC-1259","CodigoEqu":"LG-789", ClasifEqu1":"Servicio","ClasifEqu2":"VEracruz"},{"IdUnico":"00003","NumParte":"01-01-0003","UnidadM":"PZA","Fecha":"2022-10-28","Cantidad":"4.0000","Equipo":"AUTOMOVIL","Plan":"MANTO. AUTOMOVILES","Parte":"\MOTOR\","Actividad":"Mantenimiento 5000Km", "CenCosto":"CC-1259","CodigoEqu":"LG-789", ClasifEqu1":"Operación","ClasifEqu2":"Merida"},{"IdUnico":"00003","NumParte":"01-01-0003","UnidadM":"PZA","Fecha":"2022-10-28","Cantidad":"4.0000","Equipo":"AUTOMOVIL SEDAN","Plan":"MANTO. AUTOMOVILES","Parte":"\MOTOR\","Actividad":"Mantenimiento 5000Km","CenCosto":"CC-1259", "CodigoEqu":"LG-789", ClasifEqu1":"Operación","ClasifEqu2":"Veracruz"}]}

Notas:

Todos los EndPoint en caso de error regresarán como resultado una cadena JSON, con el siguiente formato: {"Error":"Mensaje con la descripción del error"}
Los parámetros de entrada marcados como cadena JSON no deben contener saltos de línea, tabuladores o caracteres especiales.
Todos los nombres de parámetros son sensibles a mayúsculas y minúsculas. Por lo tanto, deben ser escritos tal como se muestran en los ejemplos.
Todos los campos de parámetros de entrada declarados en los EndPoint deben ser incluidos. En el caso de no contar con el valor para enviar o ser no requerido; los campos de tipo texto deben ser enviados al EndPoint con valor vacío \“\” y los de tipo entero con \“0\”.

API bidireccional para conectar inventarios externos a SVISION

SSI-API para conectar inventarios externos a SVISION consta de 7 EndPoints (subprocesos) divididos en 2 procesos principales:

Nosotros realizamos la instalación del API, que consta de los siguientes actividades:

Las actividades antes mencionadas se realizarán vía remota, previa cita; ya sea por VPN o usando el programa Rustdesk. El tiempo estimando para realizar estas actividades es de 2 horas.