API Articulos/Proveedores - Historial de revisiones

Dvaldes: /* ¿Cómo consumir la API? */

2023-07-28T16:34:48Z

¿Cómo consumir la API?

← Revisión anterior		Revisión del 12:34 28 jul 2023
Línea 264:		Línea 264:
	RequestBody body = RequestBody.create(mediaType, "");		RequestBody body = RequestBody.create(mediaType, "");
	Request request = new Request.Builder()		Request request = new Request.Builder()
	.url("https://apis.serpi.com.co/api/v1/~~DocumentoContable~~")		.url("https://apis.serpi.com.co/api/v1/ArticuloProveedor")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 277:		Línea 277:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	var client = new HttpClient();		var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/~~DocumentoContable~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/ArticuloProveedor");
	request.Headers.Add("secretkey", "{{secret key}}");		request.Headers.Add("secretkey", "{{secret key}}");
	request.Headers.Add("Authorization", "Bearer{{token}}");		request.Headers.Add("Authorization", "Bearer{{token}}");
Línea 294:		Línea 294:
	require_once 'HTTP/Request2.php';		require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();		$request = new HTTP_Request2();
	$request->setUrl('https://apis.serpi.com.co/api/v1/~~DocumentoContable~~');		$request->setUrl('https://apis.serpi.com.co/api/v1/ArticuloProveedor');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

Dvaldes: /* Códigos de estado HTTP */

2023-07-28T16:34:16Z

Códigos de estado HTTP

← Revisión anterior		Revisión del 12:34 28 jul 2023
Línea 251:		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
	\|}		\|}

			== ¿Cómo consumir la API? ==

			<Tabs>

			<Tab name = "Java">
			'''Request'''
			<syntaxhighlight lang="java">
			OkHttpClient client = new OkHttpClient().newBuilder()
			.build();
			MediaType mediaType = MediaType.parse("text/plain");
			RequestBody body = RequestBody.create(mediaType, "");
			Request request = new Request.Builder()
			.url("https://apis.serpi.com.co/api/v1/DocumentoContable")
			.method("GET", body)
			.addHeader("secretkey", "{{secret key}}")
			.addHeader("Authorization", "Bearer{{token}}")
			.build();
			Response response = client.newCall(request).execute();
			</syntaxhighlight>
			</Tab>

			<Tab name = "C#">
			'''Request'''
			<syntaxhighlight lang="c#">
			var client = new HttpClient();
			var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/DocumentoContable");
			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());
			</syntaxhighlight>
			</Tab>

			<Tab name = "PHP">
			'''Request'''
			<syntaxhighlight lang="php">
			<?php
			require_once 'HTTP/Request2.php';
			$request = new HTTP_Request2();
			$request->setUrl('https://apis.serpi.com.co/api/v1/DocumentoContable');
			$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();
			}
			</syntaxhighlight>
			</Tab>

			</Tabs>

			[[Category:Documentación APIs]]
			<!-- [[Category:Pages with syntax highlighting errors]] -->

Dvaldes: /* ¿Cómo consumir la API? */

2023-07-28T16:32:41Z

¿Cómo consumir la API?

@@ Línea 229: / Línea 229: @@
 </Tabs>
-== ¿Cómo consumir la API? ==
+== Códigos de estado HTTP ==
 {| class="wikitable left"
 ! Código !! Descripción
@@ Línea 376: / Línea 251: @@
 | 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
 |}

Nalzate en 20:38 14 jun 2023

2023-06-14T20:38:46Z

← Revisión anterior		Revisión del 16:38 14 jun 2023
Línea 1:		Línea 1:
	'''Descripción:'''		'''Descripción:'''
	Esta API permite la sincronizacion de ~~aticulos~~ de proveedores entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.		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:'''		'''Autorización:'''

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronizacion de aticulos 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:''' '''Ti…»

2023-06-14T20:38:35Z

Página creada con «'''Descripción:''' Esta API permite la sincronizacion de aticulos 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:''' '''Ti…»

Página nueva

'''Descripción:'''
Esta API permite la sincronizacion de aticulos 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 '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! 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'''
<syntaxhighlight lang="JSON" line="1">
{
"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",
}
</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! 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 '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"idArticulo": 2,
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}

]

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! 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:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 articulos proveedores"
}

</syntaxhighlight>
</Tab>


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

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"id": 1,
"idArticulo": 2,
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}
]
</syntaxhighlight>

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se modificaron 10 de 10 articulos proveedores"
}

</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<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"
! 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
|}

[[Category:Documentación APIs]]