API Articulos/Lineas

De WikiSerpi
Ir a la navegación Ir a la búsqueda

Descripción: Esta API permite la sincronización del agrupador definido como Linea entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas.

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

¿Cómo funciona?

  • El consumo de esta API se realiza por método GET.
  • 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/Linea

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/Linea?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": "PRODUCTOS NO FABRICADOS",
            "facturable": "1",
            "factura_negativo": "1",
            "porcentaje_comision": "0.000",
            "traslado_negativo": "1",
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}
Campos de resultados
Campo Tipo de dato Descripción
id int Corresponde al identificador de la linea
codigo string Código
descripcion string Descripción de la linea
facturable bool Activo=1, Inactivo=0
factura_negativo bool Facturar linea en negativo
porcentaje_comision decimal Porcentaje de la comision de la linea
traslado_negativo bool trasladar en negativo (SI=1, NO=0)

</Tab>

<Tab name = "API Creación (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/Linea

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": "PRODUCTOS NO FABRICADOS",
    "facturable": "1",
    "factura_negativo": "1",
    "porcentaje_comision": "0.000",
    "traslado_negativo": "1",
}


Campos del request
Campo Tipo de dato Requerido Descripción
codigo string Si Código
descripcion string Si Descripción de la linea
facturable bool SI Activo=1, Inactivo=0
factura_negativo bool SI Facturar linea en negativo
porcentaje_comision decimal NO Porcentaje de la comision de la linea
traslado_negativo bool SI trasladar en negativo (SI=1, NO=0)

AVISO IMPORTANTE:

Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


Response 

{
    "success": true,
    "code": 201,
    "errors": null,
    "message": "registro creado exitosamente"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo descripcion es obligatorio",
        "El campo codigo es obligatorio"
    ],
    "message": "Se presentaron errores al crear el registro"
}

</Tab>

<Tab name = "API Modificar(PUT) "> EndPoint: https://www.apis.serpi.com.co/api/v1/Linea

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": "21",
    "codigo": "1",
    "descripcion": "PRODUCTOS NO FABRICADOS",
    "facturable": "1",
    "factura_negativo": "1",
    "porcentaje_comision": "0.000",
    "traslado_negativo": "1",
}


Campos del request
Campo Tipo de dato Requerido Descripción
id int Si Corresponde al identificador de la linea
codigo string Si Código
descripcion string Si Descripción de la linea
facturable bool SI Activo=1, Inactivo=0
factura_negativo bool SI Facturar linea en negativo
porcentaje_comision decimal NO Porcentaje de la comision de la linea
traslado_negativo bool SI trasladar en negativo (SI=1, NO=0)

AVISO IMPORTANTE:

Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "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 campo descripcion es obligatorio",
        "El campo codigo es obligatorio"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

</Tab> </Tabs>

¿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/Linea")
  .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/Linea");
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/Linea');
$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>

Obtenido de «https://www.wikiserpi.com/index.php?title=API_Articulos/Lineas&oldid=942»