API Documentos Contables - Historial de revisiones

Dvaldes en 15:22 21 jul 2023

2023-07-21T15:22:31Z

← Revisión anterior		Revisión del 11:22 21 jul 2023
Línea 495:		Línea 495:
	\| 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? ==		== ¿Cómo consumir la API? ==
Línea 509:		Línea 508:
	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/~~ListaPrecios~~")		.url("https://localhost:44305/api/v1/DocumentoContable")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 522:		Línea 521:
	<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/~~ListaPrecios~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/DocumentoContable");
	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 539:		Línea 538:
	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/~~ListaPrecios~~');		$request->setUrl('https://localhost:44305/api/v1/DocumentoContable');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

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

2023-07-21T15:20:50Z

¿Cómo consumir la API?

Mostrar los cambios

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

2023-07-21T14:20:51Z

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

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

Dvaldes: /* Métodos */

2023-07-05T20:56:20Z

Métodos

← Revisión anterior		Revisión del 16:56 5 jul 2023
Línea 266:		Línea 266:
	<!-- *************** CREAR **************** -->		<!-- *************** CREAR **************** -->
	<Tab name = "API Crear">		<Tab name = "API Crear">
	~~'''PUT/users'''~~

	'''EndPoint:'''		'''EndPoint:'''
Línea 304:		Línea 303:
	"cuota": 0,		"cuota": 0,
	"detalle": "SERV DE TRANSP INFORMAL",		"detalle": "SERV DE TRANSP INFORMAL",
	~~"idCentroCosto": 3,~~
	"idSubcentroCosto": 4,		"idSubcentroCosto": 4,
	"idCentroOperacion": 1,		"idCentroOperacion": 1,
Línea 322:		Línea 320:
	"cuota": 0,		"cuota": 0,
	"detalle": "SERV DE TRANSP INFORMAL",		"detalle": "SERV DE TRANSP INFORMAL",
	~~"idCentroCosto": null,~~
	"idSubcentroCosto": null,		"idSubcentroCosto": null,
	"idCentroOperacion": 1,		"idCentroOperacion": 1,
Línea 376:		Línea 373:
	\|-		\|-
	\| detalle \|\| string \|\| NO \|\| Comentarios del movimiento		\| detalle \|\| string \|\| NO \|\| Comentarios del movimiento
	\|-
	~~\| idCentroCosto \|\| Int \|\| NO \|\| Id del centro de costo del movimiento~~
	\|-		\|-
	\| idSubcentroCosto \|\| Int \|\| NO \|\| Id del subcentro de costo del movimiento		\| idSubcentroCosto \|\| Int \|\| NO \|\| Id del subcentro de costo del movimiento

Jmartinez: /* Métodos */

2023-07-05T20:39:07Z

Métodos

← Revisión anterior		Revisión del 16:39 5 jul 2023
Línea 167:		Línea 167:
	"cuota": 0,		"cuota": 0,
	"detalle": "SERV DE TRANSP INFORMAL",		"detalle": "SERV DE TRANSP INFORMAL",
	~~"idCentroCosto": 3,~~
	"idSubcentroCosto": 4,		"idSubcentroCosto": 4,
	"idCentroOperacion": 1,		"idCentroOperacion": 1,
Línea 186:		Línea 185:
	"cuota": 0,		"cuota": 0,
	"detalle": "SERV DE TRANSP INFORMAL",		"detalle": "SERV DE TRANSP INFORMAL",
	~~"idCentroCosto": null,~~
	"idSubcentroCosto": null,		"idSubcentroCosto": null,
	"idCentroOperacion": 1,		"idCentroOperacion": 1,
Línea 253:		Línea 251:
	\|-		\|-
	\| detalle \|\| string \|\| Comentarios del movimiento		\| detalle \|\| string \|\| Comentarios del movimiento
	\|-
	~~\| idCentroCosto \|\| Int \|\| Id del centro de costo del movimiento~~
	\|-		\|-
	\| idSubcentroCosto \|\| Int \|\| Id del subcentro de costo del movimiento		\| idSubcentroCosto \|\| Int \|\| Id del subcentro de costo del movimiento

Nalzate en 16:16 14 jun 2023

2023-06-14T16:16:16Z

← Revisión anterior		Revisión del 12:16 14 jun 2023
Línea 78:		Línea 78:

	'''Campo de resultados'''		'''Campo de resultados'''
	~~{\| class="wikitable"~~
	~~! Campo !! Tipo de dato !! Descripción~~
	{\| class="wikitable"		{\| class="wikitable"
	! Campo !! Tipo de dato !! Descripción		! Campo !! Tipo de dato !! Descripción
Línea 415:		Línea 413:
	</Tab>		</Tab>


	~~77777777777~~

	<!-- *************** ELIMINAR **************** -->		<!-- *************** ELIMINAR **************** -->

Nalzate en 16:13 14 jun 2023

2023-06-14T16:13:30Z

Mostrar los cambios

Gpazos en 02:09 5 jun 2023

2023-06-05T02:09:14Z

← Revisión anterior		Revisión del 22:09 4 jun 2023
Línea 1:		Línea 1:
	'''Descripción:'''		'''Descripción:'''
	Esta API ~~pemrite~~ la ~~sincronizacion~~ de ~~las actividades vinculadas a proyectos~~ entre SERPI y la plataforma que lo requiera.		Esta API permite la sincronización de los '''documentos contables''' requeridos entre SERPI y la plataforma que lo requiera.

	'''Autorización:'''		'''Autorización:'''

Gpazos: Página creada con «'''Descripción:''' Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos 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…»

2023-06-05T02:07:58Z

Página creada con «'''Descripción:''' Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos 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…»

Página nueva

'''Descripción:'''
Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos 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) ">
'''GET/users'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=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
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

''' 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 left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

''' 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 left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

'''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/Actividades")
.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/Actividades"

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