API Integración Registro o Actualización de Materiales

Versión 1.0

Proveedor-Autor Brainbox – Edú Moreno

Fecha 18 ago. 2021

Contenido 1 Información General

1.1 Objetivo del Servicio
1.2 Alcance del Servicio
1.3 Ambiente
2 Operaciones del Servicio 3
Modelado de Servicio
3.1 Método de Autenticación
3.2 Operación: Integración (Ejemplo enviando 1 material)
3.2 Resultado Posibles
3.2.1 RESULTADO [HTTP:200]
3.2.2 RESULTADO [HTTP:500]
4 Especificaciones de los campos
4.1 Leyenda
4.2 Detalle de cada campo
5 Consideraciones

1 Información General

1.1 Objetivo del Servicio

El objetivo de este servicio es registrar o actualizar materiales

1.2 Alcance del Servicio

Este servicio debe permitir registrar o actualizar los materiales

1.3 Ambiente

Ambiente Host

Development https://dev-logisticainversa.solucionesfps.pe/

Producción Por definir

2 Operaciones del Servicio

Operación Descripción

Integración Registrar o actualizar materiales.

3 Modelado de Servicio

3.1 Método de Autenticación

Se debe utilizar el método Bearer Authentication para enviar el JWT Token.

3.2 Operación: Integración (Ejemplo enviando 1 material)

 MÉTODO POST

URL /master_table/load_master_material

HEADER Content-Type: application/json

Authorization: Bearer
nyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJh****************************************************Fyta0pKJVNM87euw
BODY

[
{
"control": "X",
"descripcion": "3-GEL SUSP SACx10ML CJAx20UND",
"descripcionGrupoArticulo": "ANTIAC C/OTRAS COMBI",
"familia": "Farmacia",
"grupoArticulo": "F01010208",
"inka": "100001",
"mifa": "522987",
"precioUnitario": 13.48,
"surtido": "D006",
"zonaInduccion": "MT2 Full LPN"
}
]

3.3 Resultado Posibles

3.3.1 RESULTADO [HTTP:200]

Código de Resultado: 200

Listado masivo de motivos correctos.

{
"code": "ok",
"errors": []
}

Código de Resultado: 200

Los parámetros son incorrectos o no se ingresaron, muestra la descripción del error.

 {
"code": "error",
"errors": [
[errores]
]
}

3.3.2 RESULTADO [HTTP:403]

Código de Resultado: 403

Solicitud Incorrecta: Token no presente en el Authorization (credenciales)

{
"status": 403,
"message": "Acceso denegado",
"data": {
"error": "No se ingresó el token"
}
}

3.3.3 RESULTADO [HTTP:500]

Código de Resultado: 500

Error interno del servidor

{
"status": 500,
"message": "[Error message",
"data": {
"status": 500,
"message": "[Error Message]",
"path": "[path]"
}
}
4 Especificaciones de los campos del servicio

4.1 Leyenda:

Tipo de campo Descripción

Obligatorio Campo requerido para registrar o actualizar un material.

4.2 Detalle de cada campo:

Campo Tipo Descripción Ejemplo y Restricciones

control Obligatorio Aquellos productos sujetos a Ejemplo: X

balance trimestral que se presenta Tipo: 1 caracter
a la DIGEMID.

descripcion Obligatorio Nombre del Producto. Ejemplo: 3-GEL SUSP SACx10ML CJAx20UND
Limitante: 40 caracteres

MATERIAL descripcionGrupoArticulo Obligatorio Descripción de la agrupación del Ejemplo: ANTIAC C/OTRAS COMBI
producto. Limitante: 20 caracteres

familia Obligatorio Grupo de carga. Ejemplo: Farmacia

Limitante: 20 caracteres

grupoArticulo Obligatorio Proveedor principal. Ejemplo: F01010208

Limitante: 9 caracteres

inka Obligatorio Codigo de Material Inka. Ejemplo: 100001

Limitante: 18 caracteres

mifa Opcional Codigo de Material MFA. Ejemplo: 522987

Limitante: 18 caracteres

precioUnitario Obligatorio MBEW. Ejemplo: 13.48

Tipo: Decimal

surtido Obligatorio WSL1 Si es de chorrillos o Santa Ejemplo: D006

Anita - D006 o D011 Limitante: 4 caracteres

zonaInduccion Opcional Zona de induccion - Data maestra Ejemplo: MT2 Full LPN

Limitante: 20 caracteres

5 Consideraciones

Sección Consideración

Se debe de utilizar Bearer Token para autenticación del servicio, por lo cual en el header Authorization se debe de enviar el siguiente valor
“Bearer JWT TOKEN”
Body Se debe de enviar el header Content-Type con el valor application/json.

Los campos de material son campos requeridos para registrar o actualizar un material.