API Articulos/Grupos

Descripción: Esta API permite la sincronización del agrupador de items definido como grupo 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?

• 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) ">

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

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/CategoriaArticulo?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
Página	int	No	Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página

Response

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

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

Campos de resultados

Campo	Tipo de dato	Descripción
id	int	Identificador de la categoría
codigo	string	Código de la categoría
descripcion	string	Descripción de la categoría </Tab> <Tab name = "API Creación (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/CategoriaArticulo 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": "1", "descripcion": "CATEGORIA DEMO" } Campos del request Campo Tipo de dato Longitud Requerido Descripción codigo string 20 Si Código único de la categoría descripcion string 150 Si Descripción de la categoría AVISO IMPORTANTE: Donde los campos no sean obligatorios y no se desea asignar algún valor, pruebe digitando null o 0 en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite null. Response { "success": true, "code": 201, "errors": [], "message": "Validaciones exitosas. Registro creado exitosamente" } Validaciones { "success": false, "code": 400, "errors": [ "El codigo 1 ya existe", "El campo descripcion es obligatorio" ], "message": "Problemas de validaciones. Se presentaron errores al crear el registro" } </Tab> <Tab name = "API Modificar(PUT) "> EndPoint: https://www.apis.serpi.com.co/api/v1/CategoriaArticulo 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": "10", "descripcion": "CATEGORIA DEMO MODIFICADA" } Campos del request Campo Tipo de dato Longitud Requerido Descripción id int 11 Si Identificador de la categoría codigo string 20 Si Código único de la categoría descripcion string 150 Si Descripción de la categoría AVISO IMPORTANTE: Donde los campos no sean obligatorios y no se desea asignar algún valor, pruebe digitando null o 0 en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite null. Response { "success": true, "code": 200, "errors": [], "message": "Validaciones exitosas. Registro modificado exitosamente" } { "success": false, "code": 204, "errors": null, "message": "No se encontraron registros con el id 1" } Validaciones { "success": false, "code": 400, "errors": [ "El campo id es obligatorio", "El codigo 1 ya esta asociado a otro id", "El campo descripcion es obligatorio" ], "message": "Problemas de validaciones. 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/CategoriaArticulo") .method("GET", body) .addHeader("secretkey", "{{secret key}}") .addHeader("Authorization", "Bearer{{token}}") .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/CategoriaArticulo"); request.Headers.Add("secretkey", "{{secret key}}"); request.Headers.Add("Authorization", "Bearer{{token}}"); 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 require_once 'HTTP/Request2.php'; $request = new HTTP_Request2(); $request->setUrl('https://localhost:44305/api/v1/CategoriaArticulo'); $request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'secretkey' => '{{secret key}}', 'Authorization' => 'Bearer{{token}}' )); $request->setBody(''); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } </Tab> </Tabs>