API Articulos/Presentacion-Tipo

Descripción: Esta API permite la sincronización de los tipos de presentación de productos entre SERPI y la plataforma que lo requiera.

Autorización: Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

Beneficio:

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

• El consumo de esta API se realiza por método GET.
• Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
• Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
• En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Métodos

<Tabs> <Tab name = "API Consulta (GET) "> GET

EndPoint: https://www.apis.serpi.com.co/api/v1/tipopresentacion

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/tipopresentacion?limite=50&pagina=1

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

Parámetro	Tipo de dato	Requerido	Descripción
Límite	int	No	Este parámetro indica la cantidad de resultados que se deben devolver en una sola página

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "x registro(s) encontrados",
    "result": [
  {
            "id": 1,
            "codigo": "20",
            "descripcion": "ENVIO "
        },
]

}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}

Campo de resultados

Campo	Tipo de dato	Descripción
Id	int	Corresponde al identificador deL tipo de presentacion
Código	string	Corresponde al código deL tipo de presentacion
description	string	Descripción deL tipo de presentacion </Tab> <Tab name = "API Creación (POST) "> POST EndPoint: https://www.apis.serpi.com.co/api/v1/tipopresentacion Headers Header Descripción secretkey Secretkey proporcionada al cliente para consumos de las APIs Authorization: Usar Bearer. Ejemplo “bearer {{token}}”. {{token}} Token de autorizacion generado por SerpiERP Request { "codigo" : "U08", "descripcion": "UNICA" } Campos del request Campo Tipo Requerido Descripción código String SI Describe el tipo de presentacion descripción String SI Descripción deL tipo de presentacion Authorization: Usar Bearer. Ejemplo “bearer {{token}}”. {{token}} Token de autorizacion generado por SerpiERP Response { "success": true, "code": 201, "errors": [], "message": "Validaciones existosas. Registro creado exitosamente" } { "success": false, "code": 400, "errors": [ "El codigo 148 ya existe" ], "message": "Problemas de validaciones. Se presentaron errores al crear el registro" } </Tab> <Tab name = "API Modificar(PUT) "> PUT EndPoint: https://www.apis.serpi.com.co/api/v1/tipopresentacion Headers Header Descripción secretkey Secretkey proporcionada al cliente para consumos de las APIs Authorization: Usar Bearer. Ejemplo “bearer {{token}}”. {{token}} Token de autorizacion generado por SerpiERP Request { "id": 1, "codigo": "2", "descripcion": "ENVIO " } Campos del request Campo Tipo de dato Longitud Requerido Descripción id int 50 SI Corresponde al identificador del tipo DE presentación codigo string 50 SI Describe el código del tipo de presentación descripcion string 50 SI Descripción el tipo de presentación Authorization: Usar Bearer. Ejemplo “bearer {{token}}”. {{token}} Token de autorizacion generado por SerpiERP Response { "success": true "code": 200, "message": "registro modificado exitosamente" } { "success": false, "code": 400, "errors": [ "El campo codigo es obligatorio" ], "message": "Se presentaron errores al modificar el registro" } { "success": false, "code": 204, "errors": null, "message": "No se encontraron registros con el id xx" } { "success": false, "code": 400, "errors": [ "La codigo xx ya esta asociado al id x " ], "message": "Se presentaron errores al modificar el registro" } </Tab> </Tabs> Códigos de estado HTTP Código Descripción 200 La solicitud ha sido exitosa 201 La solicitud ha tenido éxito y ha llevado a la creación de un recurso 204 La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta 400 El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente 401 La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso 403 El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso 404 El recurso solicitado no se ha encontrado en el servidor 500 Internal Server Error 503 El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal