API Terceros/Tipo Identidad

De WikiSerpi
Ir a la navegación Ir a la búsqueda

Descripción: Esta API, permite obtener los tipos de documentos registrados en el SERPI que pueden ser vinculados a terceros registrados.

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.

Objetivo: Este API permite que la aplicación integrada conservé la integridad en los tipos de documento a utilizar.

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: https://www.apis.serpi.com.co/api/v1/TipoIdentidad

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/TipoIdentidad?limite=50&pagina=1

Headers

Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

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 

{
"success": true
	"code": 200,
	"message": "1 registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 0,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

</Tab>

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

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

Headers

Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request 

{
    "abreviatura": "NIT",
    "descripcion": "NIT",
    "codigo": 31,
    "abreviatura2": " NIT2",
    "abreviatura3": "",
    "excluirImpVentas": false
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
abreviatura string 5 Si Abreviatura Tipo de identidad
descripcion string 100 Si Descripcion tipo de identidad
codigo int 11 Si Codigo numero del tipo de identidad
abreviatura2 string 5 No Abreviatura2 Tipo de identidad
abreviatura3 string 5 No Abreviatura3 Tipo de identidad
excluirImpVentas bool 1 No true o false. Si el tipo de identidad es excluido del impuesto de ventas

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response 

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Validaciones exitosas. Registro creado exitosamente"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El abreviatura X ya existe",
        "El codigo X ya existe"
    ],
    "message": "Se presentaron errores al crear el registro"
}

</Tab>

<Tab name = "API Modificar(PUT) ">

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

Headers

Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request 

{
    "id": 1,
    "abreviatura": "NIT",
    "descripcion": "NIT",
    "codigo": 0,
    "abreviatura2": " NIT2",
    "abreviatura3": "",
    "excluirImpVentas": false
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
id int 11 Si Corresponde al identificador del tipo de identidad
abreviatura string 5 Si Abreviatura Tipo de identidad
descripcion string 100 Si Descripcion tipo de identidad
codigo int 11 SI Codigo numero del tipo de identidad
abreviatura2 string 5 No Abreviatura2 Tipo de identidad
abreviatura3 string 5 No Abreviatura3 Tipo de identidad
excluirImpVentas bool 1 No true o false. Si el tipo de identidad es excluido del impuesto de ventas

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Validaciones exitosas. Registro modificado exitosamente"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo id es obligatorio",
        "El campo descripcion es obligatorio",
        "El abreviatura X ya esta asociado al id X",
        "El codigo X ya esta asociado al id X"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

</Tab> </Tabs>

Códigos de estado HTTP

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 

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/TipoIdentidad")
  .method("GET", body)
  .addHeader("secretkey", "{{secret key}}")
  .addHeader("Authorization", "Bearer{{token}}")
  .build();
Response response = client.newCall(request).execute();

</Tab>

<Tab name = "C#"> Request 

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/TipoIdentidad");
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());

</Tab>

<Tab name = "PHP"> Request 

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/TipoIdentidad');
$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();
}

</Tab>

</Tabs>

Obtenido de «https://www.wikiserpi.com/index.php?title=API_Terceros/Tipo_Identidad&oldid=597»