API Documentos Contables/Subcentro Costos - Historial de revisiones

Dvaldes: Dvaldes trasladó la página API Documentos-Contables/Subcentro Costos a API Documentos Contables/Subcentro Costos

2023-07-21T14:21:34Z

Dvaldes trasladó la página API Documentos-Contables/Subcentro Costos a API Documentos Contables/Subcentro Costos

← Revisión anterior	Revisión del 09:21 21 jul 2023
(Sin diferencias)

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

2023-06-14T19:23:14Z

¿Cómo consumir la API?

← Revisión anterior		Revisión del 14:23 14 jun 2023
Línea 219:		Línea 219:
	RequestBody body = RequestBody.create(mediaType, "");		RequestBody body = RequestBody.create(mediaType, "");
	Request request = new Request.Builder()		Request request = new Request.Builder()
	.url("https://localhost:44305/api/v1/~~CentroCosto~~")		.url("https://localhost:44305/api/v1/SubCentroCosto")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 232:		Línea 232:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	var client = new HttpClient();		var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/~~CentroCosto~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/SubCentroCosto");
	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 249:		Línea 249:
	require_once 'HTTP/Request2.php';		require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();		$request = new HTTP_Request2();
	$request->setUrl('https://localhost:44305/api/v1/~~CentroCosto~~');		$request->setUrl('https://localhost:44305/api/v1/SubCentroCosto');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

Dvaldes: /* Métodos */

2023-06-14T19:22:42Z

Métodos

@@ Línea 58: / Línea 58: @@
      "result": [
+         {
-           "id": 1,
+            "id": 1,
-           "codigo": "01",
+            "codigo": "01",
-           "abreviatura": "ADS",
+            "abreviatura": "ADMI",
-           "descripcion": "ADMINISTRACION"
+            "descripcion": "ADMINISTRACION",
+         }
+	]
@@ Línea 79: / Línea 110: @@
 ! Campo !! Tipo de dato !! Descripción
 |-
-| id || int || Identificador del centro de costo
+| id || int || Identificador del subcentro de costo
 |-
-| codigo|| string || Abreviatura del centro de costo
+| codigo || string || Código único del subcentro de costo
 |-
-| abreviatura || string || Abreviatura del centro de costo
+| abreviatura || string || Abreviatura del subcentro de costo
 |-
-| descripcion || string || Descripción del centro de costo
+| descripcion || string || Descripción del subcentro de costo
 |}
 </Tab>

Dvaldes: /* Métodos */

2023-06-14T19:05:07Z

Métodos

Mostrar los cambios

Dvaldes en 19:03 14 jun 2023

2023-06-14T19:03:34Z

← Revisión anterior		Revisión del 14:03 14 jun 2023
Línea 8:		Línea 8:

	'''Tipos de peticiones:'''		'''Tipos de peticiones:'''
	GET~~, POST, PUT~~		GET

	'''¿Cómo funciona?'''		'''¿Cómo funciona?'''

Gpazos: Página creada con «'''Descripción:''' Esta API permite la sincronización de los '''Subcentros de costos''' entre SERPI y la plataforma que lo requiera. '''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 funcio…»

2023-06-05T02:10:53Z

Página creada con «'''Descripción:''' Esta API permite la sincronización de los '''Subcentros de costos''' entre SERPI y la plataforma que lo requiera. '''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 funcio…»

Página nueva

'''Descripción:'''
Esta API permite la sincronización de los '''Subcentros de costos''' entre SERPI y la plataforma que lo requiera.

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

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/SubCentroCosto</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/SubCentroCosto?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del centro de costo
|-
| codigo|| string || Abreviatura del centro de costo
|-
| abreviatura || string || Abreviatura del centro de costo
|-
| descripcion || string || Descripción del centro de costo
|}
</Tab>


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

{| 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">
{
"codigo": "02",
"abreviatura": "VE",
"descripcion": "VENTAS"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"La abreviatura CO1 ya existe",
"El campo descripcion es obligatorio",
"El codigo 957 ya existe",
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

{| 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">
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del centro de costo
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"La abreviatura CO1 ya esta asociado al id x",
"El campo descripcion es obligatorio",
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</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
|}

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