API Articulos/Marcas

Descripción: Esta API permite la sincronizacion de Marcas ligadas a los items 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/Marca

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/Marca?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": "2",
            "descripcion": "GASTOS ENVIO"
        },
]

}

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

Campo de resultados

Campo	Tipo de dato	Descripción
Id	int	Corresponde al identificador de la marca
Código	string	Corresponde al código de la marca
description	string	Descripción de la marca </Tab> <Tab name = "API Creación (POST) "> POST EndPoint: https://www.apis.serpi.com.co/api/v1/marca 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" : "A08", "descripcion": "PRUEBAS" } Campos del request Campo Tipo Requerido Descripción código String SI Describe el código de la categoría descripción String SI Descripción de la marca Authorization: Usar Bearer. Ejemplo “bearer {{token}}”. {{token}} Token de autorizacion generado por SerpiERP Response {{ "success": true, "code": 201, "errors": null, "message": "registro creado exitosamente" } { "success": false, "code": 400, "errors": [ "El codigo 44 ya existe" ], "message": "Se presentaron errores al crear el registro" } </Tab> <Tab name = "API Modificar(PUT) "> PUT EndPoint: https://www.apis.serpi.com.co/api/v1/Marca 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": "GASTOS ENVIO " } Campos del request Campo Tipo de dato Longitud Requerido Descripción id int 50 SI Corresponde al identificador de la marca codigo string 50 SI Describe el código de la marca descripcion string 50 SI Descripción de la marca 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 44 ya esta asociado al id 2" ], "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 ¿Cómo consumir la API? <Tabs> <Tab name = "Java"> Request OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = RequestBody.create(mediaType, ""); Request request = new Request.Builder() .url("https://localhost:44305/api/v1/marca") .method("GET", body) .addHeader("secretkey", "ABc-zaw3+7uio-*") .addHeader("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLrl5NCdQfosUBqVeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ") .build(); Response response = client.newCall(request).execute(); </Tab> <Tab name = "C#"> Request var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/marca"); request.Headers.Add("secretkey", "ABc-xxsse3444.123"); request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLCJ1bmlxdWVfeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ"); var content = new StringContent("", null, "text/plain"); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync()); </Tab> <Tab name = "PHP"> Request <?php $client = new http\Client; $request = new http\Client\Request; $request->setRequestUrl('https://localhost:44305/api/v1/marca'); $request->setRequestMethod('GET'); $body = new http\Message\Body; $request->setBody($body); $request->setOptions(array()); $request->setHeaders(array( 'secretkey' => 'ABc-xyzas234*-.123', 'Authorization' => 'Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLHq0Ws9gqz7egNQ' )); $client->enqueue($request)->send(); $response = $client->getResponse(); echo $response->getBody(); </Tab> </Tabs>