Diferencia entre revisiones de «API Articulos/Proveedores»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
← Edición anteriorEdición siguiente →
VisualWikitexto
Sin resumen de edición
Línea 229: Línea 229:
</Tabs>
</Tabs>


== ¿Cómo consumir la API? ==
== Códigos de estado HTTP ==
 
<Tabs>
 
<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https:///www.apis.serpi.com.co/api/v1/ArticuloProveedor")
  .method("GET", body)
  .addHeader("secretkey", "{Secret Key}")
  .addHeader("Authorization", "{Bearer Token}")
  .build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
 
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</Tab>
 
<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests
 
url = "https://www.apis.serpi.com.co/api/v1/ArticuloProveedor"
 
payload = {}
headers = {
  'secretkey': '{Secret Key}',
  'Authorization': '{Bearer Token}'
}
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)
 
</syntaxhighlight>
 
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</Tab>
 
<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/ArticuloProveedor');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'secretkey' => '{Secret Key}',
  'Authorization' => '{Bearer Token}'
));
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();
}
</syntaxhighlight>
 
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</Tab>
 
</Tabs>
 
''' Códigos de estado HTTP'''
{| class="wikitable left"
{| class="wikitable left"
! Código !! Descripción
! Código !! Descripción
Línea 376: Línea 251:
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}
|}
[[Category:Documentación APIs]]
<!-- [[Category:Pages with syntax highlighting errors]] -->

Revisión del 12:32 28 jul 2023

Descripción: Esta API permite la sincronizacion de articulos de proveedores entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

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 Consultar(GET)"> GET/users

EndPoint: https://www.apis.serpi.com.co/api/v1/ArticuloProveedor?limite=10&pagina=1&idArticulo=2

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
idArticulo int No Identificador del articulo a filtrar

Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "idArticulo": 2,
            "descripcion": "ARTICULO1",
            "nitProveedor": "1234567890",
            "codigoProveedor": "101",
            "descripcionProveedor": "ARTICULO UNO",
            "proveedorPredeterminado": true,
            "multiploCompra": 1.00,
            "pedidoMinimo": 1.00000
        }
    ]
}

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

Campo de resultados

Campo Tipo Descripción
id int Corresponde al id del registro ArticuloProveedor
idArticulo int Id del artículo al que pertenece el registro
descripcion string Descripción del artículo
nitProveedor string Número de identificación del proveedor
codigoProveedor string Código del artículo del proveedor
descripcionProveedor string Descripción del artículo del proveedor
proveedorPredeterminado bool Indica si es el proveedor predeterminado del artículo
multiploCompra decimal Múltiplo de compra
pedidoMinimo decimal Pedido mínimo

</Tab>

<Tab name = "API Crear(POST)"> POST /users

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

Headers

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

Body: 

[
	{
		"idArticulo": 2,
		"nitProveedor": "1234567890",
		"codigoProveedor": "101",
		"descripcionProveedor": "ARTICULO UNO",
		"proveedorPredeterminado": true,
		"multiploCompra": 1.00,
		"pedidoMinimo": 1.00000
    }

]

Campos del request

Campo Tipo Requerido Descripción
idArticulo int SI Id del artículo al que pertenece el registro
nitProveedor string SI Número de identificación del proveedor
codigoProveedor string SI Código del artículo del proveedor
descripcionProveedor string SI Descripción del artículo del proveedor
proveedorPredeterminado bool SI Indica si es el proveedor predeterminado del artículo
multiploCompra decimal NO Múltiplo de compra
pedidoMinimo decimal NO Pedido mínimo



Authorization: 

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

Response 

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Se crearon 10 de 10 articulos proveedores"
}

</Tab>


<Tab name = "API Modificar(PUT)"> PUT/users

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

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

Body: 

[
	{
		"id": 1,
		"idArticulo": 2,
		"nitProveedor": "1234567890",
		"codigoProveedor": "101",
		"descripcionProveedor": "ARTICULO UNO",
		"proveedorPredeterminado": true,
		"multiploCompra": 1.00,
		"pedidoMinimo": 1.00000
    }
]

Authorization: 

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

Response 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se modificaron 10 de 10 articulos proveedores"
}

</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
Obtenido de «https://www.wikiserpi.com/index.php?title=API_Articulos/Proveedores&oldid=936»