API Inventarios/Saldo Inventarios - Historial de revisiones

Dvaldes: /* Métodos */

2023-07-14T12:35:24Z

Métodos

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

2023-07-14T12:33:52Z

¿Cómo consumir la API?

← Revisión anterior		Revisión del 08:33 14 jul 2023
Línea 278:		Línea 278:
	<Tab name = "Java">		<Tab name = "Java">
	'''Request'''		'''Request'''
	<syntaxhighlight lang="java~~" line="1~~">		<syntaxhighlight lang="java">
	OkHttpClient client = new OkHttpClient().newBuilder()		OkHttpClient client = new OkHttpClient().newBuilder()
	.build();		.build();
Línea 284:		Línea 284:
	RequestBody body = RequestBody.create(mediaType, "");		RequestBody body = RequestBody.create(mediaType, "");
	Request request = new Request.Builder()		Request request = new Request.Builder()
	.url("https://~~/www.apis.serpi.com.co~~/api/v1/SaldoInventario")		.url("https://localhost:44305/api/v1/SaldoInventario")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{~~Secret Key~~}")		.addHeader("secretkey", "{{secret key}}")
	.addHeader("Authorization", "{~~Bearer Token~~}")		.addHeader("Authorization", "Bearer{{token}}")
	.build();		.build();
	Response response = client.newCall(request).execute();		Response response = client.newCall(request).execute();
Línea 293:		Línea 293:
	</Tab>		</Tab>

	<Tab name = "~~Python~~">		<Tab name = "C#">
	'''Request'''		'''Request'''
	<syntaxhighlight lang="~~java" line="1~~">		<syntaxhighlight lang="c#">
	~~import requests~~		var client = new HttpClient();
			var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/SaldoInventario");
	~~url~~ = "https://~~www.apis.serpi.com.co~~/api/v1/SaldoInventario"		request.Headers.Add("secretkey", "{{secret key}}");
			request.Headers.Add("Authorization", "Bearer{{token}}");
	~~payload =~~ {}		var content = new StringContent("", null, "text/plain");
	~~headers = {~~		request.Content = content;
	~~'secretkey': '{Secret Key~~}',		var response = await client.SendAsync(request);
	'Authorization~~': '~~{~~Bearer Token~~}'		response.EnsureSuccessStatusCode();
	}		Console.WriteLine(await response.Content.ReadAsStringAsync());

	~~response~~ = ~~requests.request~~("~~GET~~", ~~url~~, ~~headers~~=~~headers, data~~=~~payload~~)

	~~print~~(response.~~text~~)

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

	<Tab name = "~~Php~~">		<Tab name = "PHP">
	'''Request'''		'''Request'''
	<syntaxhighlight lang="~~java" line="1~~">		<syntaxhighlight lang="php">
	<?php		<?php
	require_once 'HTTP/Request2.php';		require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();		$request = new HTTP_Request2();
	$request->setUrl('https://~~www.apis.serpi.com.co~~/api/v1/SaldoInventario');		$request->setUrl('https://localhost:44305/api/v1/SaldoInventario');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(
Línea 325:		Línea 320:
	));		));
	$request->setHeader(array(		$request->setHeader(array(
	'secretkey' => '{~~Secret Key~~}',		'secretkey' => '{{secret key}}',
	'Authorization' => '{~~Bearer Token~~}'		'Authorization' => 'Bearer{{token}}'
	));		));
			$request->setBody('');
	try {		try {
	$response = $request->send();		$response = $request->send();
Línea 345:		Línea 341:

	</Tabs>		</Tabs>


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

Dvaldes: /* Métodos */

2023-07-14T11:19:45Z

Métodos

← Revisión anterior		Revisión del 07:19 14 jul 2023
Línea 18:		Línea 18:
	<!-- *************** GET **************** -->		<!-- *************** GET **************** -->
	<Tab name = "API Consulta (GET) ">		<Tab name = "API Consulta (GET) ">
	~~'''GET/users'''~~

	'''EndPoint:'''		'''EndPoint:'''
	https://www.apis.serpi.com.co/api/v1/SaldoInventario		https://www.apis.serpi.com.co/api/v1/SaldoInventario
Línea 44:		Línea 42:
	! Parámetro !! Tipo de dato !! Requerido !! Descripción		! Parámetro !! Tipo de dato !! Requerido !! Descripción
	\|-		\|-
	\| fechaCorte \|\| string \|\| No \|\| Este parámetro indica la fecha de corte en el formato YYYY-MM-DD. Por ejemplo, 2023-01-01.		\| fechaCorte \|\| string \|\| Si \|\| Este parámetro indica la fecha de corte en el formato YYYY-MM-DD. Por ejemplo, 2023-01-01.
	\|-		\|-
	\| idArticulo \|\| int \|\| No \|\| Este parámetro indica el id del articulo que desea consultar.		\| idArticulo \|\| int \|\| No \|\| Este parámetro indica el id del articulo que desea consultar.

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

2023-06-21T14:19:20Z

¿Cómo consumir la API?

@@ Línea 250: / Línea 250: @@
 </Tab>
 </Tabs>
 == ¿Cómo consumir la API? ==
@@ Línea 269: / Línea 292: @@
    .build();
 Response response = client.newCall(request).execute();
 </syntaxhighlight>
 </Tab>
@@ Línea 306: / Línea 312: @@
 print(response.text)
 </syntaxhighlight>
 </Tab>
@@ Línea 353: / Línea 342: @@
 catch(HTTP_Request2_Exception $e) {
    echo 'Error: ' . $e->getMessage();
+}
 </syntaxhighlight>
@@ Línea 375: / Línea 347: @@
 </Tabs>
 [[Category:Documentación APIs]]
 <!-- [[Category:Pages with syntax highlighting errors]] -->

Dvaldes en 14:17 21 jun 2023

2023-06-21T14:17:51Z

← Revisión anterior		Revisión del 10:17 21 jun 2023
Línea 24:		Línea 24:

	'''EndPoint con parámetros:'''		'''EndPoint con parámetros:'''
	https://www.apis.serpi.com.co/api/v1/SaldoInventario?fechaCorte=2023-05-31&idArticulo=1&idBodega=1		https://www.apis.serpi.com.co/api/v1/SaldoInventario?fechaCorte=2023-01-01&idArticulo=1&idBodega=1


Línea 44:		Línea 44:
	! Parámetro !! Tipo de dato !! Requerido !! Descripción		! 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~~		\| fechaCorte \|\| string \|\| No \|\| Este parámetro indica la fecha de corte en el formato YYYY-MM-DD. Por ejemplo, 2023-01-01.
	\|-		\|-
	\| ~~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 \|\| Este parámetro indica el id del articulo que desea consultar.
			\|-
			\| idBodega \|\| int \|\| No \|\| Este parámetro indica el id de la bodega del artículo o la que desee consultar.
	\|}		\|}

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

2023-06-02T16:49:52Z

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

Página nueva

'''Descripción:'''
Esta API permite la sincronizacion de saldos inventario 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 Consulta (GET) ">
'''GET/users'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/SaldoInventario?fechaCorte=2023-05-31&idArticulo=1&idBodega=1

''' 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
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"idArticulo": 11,
"descripcion": "ARTICULO1",
"codigo": "1001",
"idBodega": 3,
"codigoBodega": "09876",
"saldo": 45.00
}

]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| idArticulo || int || Corresponde al identificador del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| codigo || string || Codigo del articulo
|-
| idBodega || int || Corresponde al identificador del la bodega
|-
| codigoBodega || string || Codigo o abreviatura de la bodega
|-
| Saldo || decimal || Saldo en inventario del articulo
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''POST /users'''

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

''' 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>

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| idArticulo || int || 50 || SI || Corresponde al identificador del Articulo
|-
| descripcion || string || 50 || SI || Descripcion del Articulo
|-
| codigo || string || 50 || SI || Codigo del articulo
|-
| idBodega || int || 50 || SI || Corresponde al identificador del la bodega
|-
| codigoBodega || string || 50 || SI || Codigo o abreviatura de la bodega
|-
| Saldo || decimal || 50 || SI || Saldo en inventario del articulo
|}

'''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": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

''' 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>

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| idArticulo || int || 50 || SI || Corresponde al identificador del Articulo
|-
| descripcion || string || 50 || SI || Descripcion del Articulo
|-
| codigo || string || 50 || SI || Codigo del articulo
|-
| idBodega || int || 50 || SI || Corresponde al identificador del la bodega
|-
| codigoBodega || string || 50 || SI || Codigo o abreviatura de la bodega
|-
| Saldo || decimal || 50 || SI || Saldo en inventario del articulo
|}

'''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,
"message": "registro modificado exitosamente"
}

{
"success": false,
"code": 400,
"errors": [
"El campo abreviatura 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"
}
</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/SaldoInventario")
.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/SaldoInventario"

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/SaldoInventario');
$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]]