Nalzate en 14:18 30 oct 2023

2023-10-30T14:18:48Z

@@ Línea 347: / Línea 347: @@
 </Tab>
 </Tabs>
 == ¿Cómo consumir la API? ==

Nalzate en 20:21 29 ago 2023

2023-08-29T20:21:10Z

← Revisión anterior		Revisión del 16:21 29 ago 2023
Línea 334:		Línea 334:
	\|-		\|-
	\| idFormula \|\| NO \|\| id de la Formula a eliminar		\| idFormula \|\| NO \|\| id de la Formula a eliminar
	\|)		\|}

	'''Response'''		'''Response'''

Nalzate en 20:19 29 ago 2023

2023-08-29T20:19:58Z

← Revisión anterior		Revisión del 16:19 29 ago 2023
Línea 312:		Línea 312:
	<Tab name = "API Eliminar(DELETE) ">		<Tab name = "API Eliminar(DELETE) ">
	'''EndPoint:'''		'''EndPoint:'''
	https://www.apis.serpi.com.co/api/v1/Formula?idFormula		https://www.apis.serpi.com.co/api/v1/Formula?idFormula=1

	{\| class="wikitable"		{\| class="wikitable"
Línea 327:		Línea 327:
	{{token}} Token de autorizacion generado por SerpiERP		{{token}} Token de autorizacion generado por SerpiERP
	</syntaxhighlight>		</syntaxhighlight>

			{\| class="wikitable"
			\|+ Parámetros
			\|-
			! Parámetro !! Requerido !! Descripción
			\|-
			\| idFormula \|\| NO \|\| id de la Formula a eliminar
			\|)

	'''Response'''		'''Response'''

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Formulas 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…»

2023-08-29T14:31:19Z

Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Formulas 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…»

Página nueva

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Formulas 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 Tipo de Materiales(GET)">

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

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

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

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"tipoMaterial": "COMPONENTE"
},
{
"id": 2,
"tipoMaterial": "PRODUCTO SECUNDARIO"
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del tipo de material
|-
| tipoMaterial || string || Tipo de Material
|}
</Tab>


<Tab name = "API Consultar Formulas(GET) ">

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

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

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

{| class="wikitable"
|+ 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 || Id del articulo a buscar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 60,
"idArticulo": 120,
"codigo": "COD1",
"descripcion": "ARTICULO1",
"naturaleza": "E",
"idunidadmedida": 4,
"unidadmedida": "KILOGRAMOS",
"materiales": [
{
"idDetalle": 60,
"idArticulo": 649,
"codigo": "COD60",
"descripcion": "ARTICULO60",
"idTipoMaterial": 1,
"tipoMaterial": "COMPONENTE",
"cantidad": 0.0025,
"idunidadmedida": 3,
"unidadmedida": "UNIDAD"
},
{
"idDetalle": 60,
"idArticulo": 282,
"codigo": "COD2",
"descripcion": "CODIGO2",
"idTipoMaterial": 1,
"tipoMaterial": "COMPONENTE",
"cantidad": 0.003,
"idunidadmedida": 4,
"unidadmedida": "KILOGRAMOS"
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro de la formula
|-
| idArticulo || int || Id del Articulo
|-
| codigo || string || Codigo del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| naturaleza || string || E=Ensamble, S=Desemsamble
|-
| idunidadmedida || int || Id de la unidad de medida
|-
| unidadmedida || string || Descripcion de la unidad de medida
|-
| materiales || Array[ObjetoMateriales] || Array de objetos de los materiales de la formula
|}

'''ObjetoMateriales'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idDetalle || Int || Corresponde al id del material
|-
| idArticulo || int || Id del Articulo
|-
| codigo || string || Codigo del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| IdTipoMaterial || int || Id del tipo de material
|-
| TipoMaterial || string || Descripcion del tipo de material
|-
| cantidad || decimal || Cantidad vendida
|-
| Idunidadmedida || int || Id de la unidad de medida
|-
| unidadmedida || string || Descripcion de la unidad de medida
|}

</Tab>


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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"idArticulo": 120,
"naturaleza": "E",
"idunidadmedida": 4,
"materiales": [
{
"idArticulo": 649,
"idTipoMaterial": 1,
"cantidad": 0.0025,
"idunidadmedida": 3
},
{
"idArticulo": 282,
"idTipoMaterial": 2,
"cantidad": 0.003,
"idunidadmedida": 4
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo
|-
| naturaleza || String || SI || E=Ensamble, S=Desemsamble
|-
| idunidadmedida || Int || NO || Id de la unidad de medida
|-
| materiales || Array[ObjetoMateriales] || SI || Array de objetos de los materiales de la formula
|}

'''ObjetoMateriales'''

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo
|-
| idTipoMaterial || Int || SI || Id del tipo de material
|-
| cantidad || decimal || SI || Cantidad vendida
|-
| idunidadmedida || Int || NO || Id de la unidad de medida
|}

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

</syntaxhighlight>
</Tab>


<Tab name = "API Eliminar(DELETE) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Formula?idFormula

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

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

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": " Se elimino la formula correctamente"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿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://localhost:44305/api/v1/Formula")
.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://localhost:44305/api/v1/Formula");
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://localhost:44305/api/v1/Formula');
$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]]

API Formulas - Historial de revisiones

Nalzate en 14:18 30 oct 2023

Nalzate en 20:21 29 ago 2023

Nalzate en 20:19 29 ago 2023