https://www.wikiserpi.com/index.php?action=history&feed=atom&title=API_Terceros%2FPaises
API Terceros/Paises - Historial de revisiones
2026-09-28T04:06:19Z
Historial de revisiones de esta página en la wiki
MediaWiki 1.43.0
https://www.wikiserpi.com/index.php?title=API_Terceros/Paises&diff=588&oldid=prev
Dvaldes: /* Métodos */
2023-06-21T14:02:42Z
<p><span class="autocomment">Métodos</span></p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="es">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Revisión anterior</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revisión del 10:02 21 jun 2023</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l21">Línea 21:</td>
<td colspan="2" class="diff-lineno">Línea 21:</td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>'''EndPoint:'''</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>'''EndPoint:'''</div></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>https://www.apis.serpi.com.co/api/v1/Pais</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>https://www.apis.serpi.com.co/api/v1/Pais</div></td></tr>
<tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"></del></div></td><td colspan="2" class="diff-side-added"></td></tr>
<tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;">'''EndPoint con parámetros:'''</del></div></td><td colspan="2" class="diff-side-added"></td></tr>
<tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"></del></div></td><td colspan="2" class="diff-side-added"></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="wikitable"</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="wikitable"</div></td></tr>
</table>
Dvaldes
https://www.wikiserpi.com/index.php?title=API_Terceros/Paises&diff=587&oldid=prev
Dvaldes: Página creada con «'''Descripción:''' PENDIENTE '''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:''' PENDIENTE '''Tipos de peticiones:''' GET, POST, PUT '''¿Cómo funciona?''' PENDIENTE == Métodos == <Tabs> <!-- ***************************************************…»
2023-06-21T14:01:42Z
<p>Página creada con «'''Descripción:''' PENDIENTE '''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:''' PENDIENTE '''Tipos de peticiones:''' GET, POST, PUT '''¿Cómo funciona?''' PENDIENTE == Métodos == <Tabs> <!-- ***************************************************…»</p>
<p><b>Página nueva</b></p><div>'''Descripción:'''<br />
PENDIENTE<br />
<br />
'''Autorización:'''<br />
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.<br />
<br />
'''Beneficio:'''<br />
PENDIENTE<br />
<br />
'''Tipos de peticiones:'''<br />
GET, POST, PUT<br />
<br />
'''¿Cómo funciona?'''<br />
PENDIENTE<br />
<br />
== Métodos ==<br />
<Tabs><br />
<!-- ************************************************************** GET ********************************************************************** --><br />
<Tab name = "API Consulta (GET) "><br />
<br />
'''EndPoint:'''<br />
https://www.apis.serpi.com.co/api/v1/Pais<br />
<br />
'''EndPoint con parámetros:'''<br />
<br />
<br />
{| class="wikitable"<br />
|+ Headers<br />
|-<br />
! Header !! Descripción <br />
|-<br />
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs<br />
|}<br />
<br />
'''Authorization:'''<br />
<syntaxhighlight ><br />
Usar Bearer. Ejemplo “bearer {{token}}”.<br />
{{token}} Token de autorizacion generado por SerpiERP<br />
</syntaxhighlight><br />
<br />
{| class="wikitable"<br />
|+ Parámetros<br />
|-<br />
! Parámetro !! Tipo de dato !! Requerido !! Descripción<br />
|-<br />
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página<br />
|-<br />
| 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<br />
|}<br />
<br />
'''Response'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"success": true,<br />
"code": 200,<br />
"errors": null,<br />
"message": "1 registro(s) encontrados",<br />
"result": [<br />
{<br />
"id": 1,<br />
"nombre": "COLOMBIA",<br />
"codigo": "57",<br />
"codigo_alfa": "CO"<br />
}<br />
]<br />
}<br />
<br />
{<br />
"success": true<br />
"code": 201,<br />
"message": "No se encontraron registros",<br />
"result": []<br />
}<br />
</syntaxhighlight><br />
<br />
{| class="wikitable"<br />
|+ Campos de resultados<br />
|-<br />
! Campo !! Tipo de dato !! Descripción<br />
|-<br />
| id || int || Identificador del país<br />
|-<br />
| nombre || string || Nombre del país<br />
|-<br />
| codigo || string || Código del país<br />
|-<br />
| codigo_alfa || string || Nomenclatura del país<br />
|}<br />
</Tab><br />
<br />
<!-- ************************************************************** POST ********************************************************************** --><br />
<Tab name = "API Creación (POST) "><br />
'''EndPoint:'''<br />
https://www.apis.serpi.com.co/api/v1/Pais<br />
<br />
{| class="wikitable"<br />
|+ Headers<br />
|-<br />
! Header !! Descripción <br />
|-<br />
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs<br />
|}<br />
<br />
'''Authorization:'''<br />
<syntaxhighlight><br />
Usar Bearer. Ejemplo “bearer {{token}}”.<br />
{{token}} Token de autorizacion generado por SerpiERP<br />
</syntaxhighlight><br />
<br />
<br />
'''Request'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"nombre": "PAIS DEMO",<br />
"codigo": "1",<br />
"codigo_alfa": "PD"<br />
}<br />
</syntaxhighlight><br />
<br />
<br />
{| class="wikitable"<br />
|+ Campos del request<br />
|-<br />
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción<br />
|-<br />
| nombre || string || 45 || Si || Nombre del país <br />
|-<br />
| codigo || string || 3 || Si || Código del país<br />
|-<br />
| codigo_alfa || string || 5 || No || Nomenclatura del país<br />
|}<br />
<br />
==== '''AVISO IMPORTANTE:''' ====<br />
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.<br />
<br />
<br />
'''Response'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"success": true,<br />
"code": 201,<br />
"errors": null,<br />
"message": "registro creado exitosamente"<br />
}<br />
</syntaxhighlight><br />
<br />
'''Validaciones'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"success": false,<br />
"code": 400,<br />
"errors": null,<br />
"message": "El codigo del pais ya existe"<br />
}<br />
</syntaxhighlight><br />
</Tab><br />
<br />
<!-- ************************************************************** PUT ********************************************************************** --><br />
<Tab name = "API Modificar(PUT) "><br />
'''EndPoint:'''<br />
https://www.apis.serpi.com.co/api/v1/Pais<br />
<br />
{| class="wikitable"<br />
|+ Headers<br />
|-<br />
! Header !! Descripción <br />
|-<br />
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs<br />
|}<br />
<br />
'''Authorization:'''<br />
<syntaxhighlight><br />
Usar Bearer. Ejemplo “bearer {{token}}”.<br />
{{token}} Token de autorizacion generado por SerpiERP<br />
</syntaxhighlight><br />
<br />
<br />
'''Request'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"id": 1,<br />
"nombre": "PAIS DEMO",<br />
"codigo": "1",<br />
"codigo_alfa": "PD"<br />
}<br />
</syntaxhighlight><br />
<br />
<br />
{| class="wikitable"<br />
|+ Campos del request<br />
|-<br />
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción<br />
|-<br />
| id || int || 11 || Si || Identificador del país<br />
|-<br />
| nombre || string || 45 || Si || Nombre del país <br />
|-<br />
| codigo || string || 3 || Si || Código del país<br />
|-<br />
| codigo_alfa || string || 5 || No || Nomenclatura del país<br />
|}<br />
<br />
==== '''AVISO IMPORTANTE:''' ====<br />
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.<br />
<br />
<br />
'''Response'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"success": true,<br />
"code": 200,<br />
"errors": null,<br />
"message": "registro modificado exitosamente"<br />
}<br />
<br />
{<br />
"success": false,<br />
"code": 204,<br />
"errors": null,<br />
"message": "No se encontraron registros con el id X"<br />
}<br />
</syntaxhighlight><br />
<br />
'''Validaciones'''<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"success": false,<br />
"code": 400,<br />
"errors": [<br />
"El campo id es obligatorio"<br />
],<br />
"message": "Se presentaron errores al modificar el registro"<br />
}<br />
</syntaxhighlight><br />
</Tab><br />
</Tabs><br />
<br />
== Códigos de estado HTTP ==<br />
{| class="wikitable left"<br />
! Código !! Descripción<br />
|-<br />
| 200 || La solicitud ha sido exitosa<br />
|-<br />
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso<br />
|-<br />
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta<br />
|-<br />
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente<br />
|-<br />
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso<br />
|-<br />
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso<br />
|-<br />
| 404 || El recurso solicitado no se ha encontrado en el servidor<br />
|-<br />
| 500 || Internal Server Error<br />
|-<br />
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal<br />
|}<br />
<br />
== ¿Cómo consumir la API? ==<br />
<br />
<Tabs><br />
<br />
<Tab name = "Java"><br />
'''Request'''<br />
<syntaxhighlight lang="java"><br />
OkHttpClient client = new OkHttpClient().newBuilder()<br />
.build();<br />
MediaType mediaType = MediaType.parse("text/plain");<br />
RequestBody body = RequestBody.create(mediaType, "");<br />
Request request = new Request.Builder()<br />
.url("https://localhost:44305/api/v1/Pais")<br />
.method("GET", body)<br />
.addHeader("secretkey", "{{secret key}}")<br />
.addHeader("Authorization", "Bearer{{token}}")<br />
.build();<br />
Response response = client.newCall(request).execute();<br />
</syntaxhighlight><br />
</Tab><br />
<br />
<Tab name = "C#"><br />
'''Request'''<br />
<syntaxhighlight lang="c#"><br />
var client = new HttpClient();<br />
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/Pais");<br />
request.Headers.Add("secretkey", "{{secret key}}");<br />
request.Headers.Add("Authorization", "Bearer{{token}}");<br />
var content = new StringContent("", null, "text/plain");<br />
request.Content = content;<br />
var response = await client.SendAsync(request);<br />
response.EnsureSuccessStatusCode();<br />
Console.WriteLine(await response.Content.ReadAsStringAsync());<br />
</syntaxhighlight><br />
</Tab><br />
<br />
<Tab name = "PHP"><br />
'''Request'''<br />
<syntaxhighlight lang="php"><br />
<?php<br />
require_once 'HTTP/Request2.php';<br />
$request = new HTTP_Request2();<br />
$request->setUrl('https://localhost:44305/api/v1/Pais');<br />
$request->setMethod(HTTP_Request2::METHOD_GET);<br />
$request->setConfig(array(<br />
'follow_redirects' => TRUE<br />
));<br />
$request->setHeader(array(<br />
'secretkey' => '{{secret key}}',<br />
'Authorization' => 'Bearer {{token}}'<br />
));<br />
$request->setBody('');<br />
try {<br />
$response = $request->send();<br />
if ($response->getStatus() == 200) {<br />
echo $response->getBody();<br />
}<br />
else {<br />
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .<br />
$response->getReasonPhrase();<br />
}<br />
}<br />
catch(HTTP_Request2_Exception $e) {<br />
echo 'Error: ' . $e->getMessage();<br />
}<br />
</syntaxhighlight><br />
</Tab><br />
<br />
</Tabs><br />
<br />
[[Category:Documentación APIs]]<br />
<!-- [[Category:Pages with syntax highlighting errors]] --></div>
Dvaldes