API Documentos Contables/Centro Operaciones

Descripción: Esta API permite la sincronización de los Centros de Operaciones 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: https://www.apis.serpi.com.co/api/v1/CentroOperacion

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/CentroOperacion?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,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "abreviatura": "1",
            "descripcion": "CENTRO DE OPERACIONES DEMO",
            "direccion": "CALLE 1 # 2-3",
            "codigo_pais": 1,
            "pais": "COLOMBIA",
            "codigo_departamento": 76,
            "departamento": "VALLE DEL CAUCA",
            "codigo_ciudad": 76001,
            "ciudad": "SANTIAGO DE CALI",
            "telefono": 1234567,
            "movil": "1234567890"
        }
	]
}

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

Campos de resultados

Campo	Tipo de dato	Descripción
id	int	Identificador del centro de operación
abreviatura	string	Abreviatura del centro de operación
descripcion	string	Descripción del centro de operación
direccion	string	Dirección del centro de operación
codigo_pais	int	Código del país
pais	string	Nombre del país
codigo_departamento	int	Código del departamento
departamento	string	Nombre del departamento
codigo_ciudad	int	Código de ciudad
ciudad	string	Nombre de la ciudad
telefono	int	Teléfono del centro de operación
movil	string	Número de celular del centro de operación

</Tab>

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

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": "CO1",
    "descripcion": "CENTRO DE OPERACION DEMO",
    "direccion": "CALLE 1 # 2-3",
    "codigo_pais": 1,
    "codigo_departamento": 76,
    "codigo_ciudad": 76001,
    "telefono": 1234567,
    "movil": "1234567890"
}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
abreviatura	string	11	Si	Abreviatura del centro de operación
descripcion	string	11	Si	Descripción del centro de operación
direccion	string	11	Si	Dirección del centro de operación
codigo_pais	int	11	Si	Código del país
codigo_departamento	int	11	Si	Código del departamento
codigo_ciudad	int	11	Si	Código de ciudad
telefono	int	11	No	Teléfono del centro de operación
movil	string	11	Si	Número de celular del centro de operación

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

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

Validaciones

{
    "success": false,
    "code": 400,
    "errors": [
        "La abreviatura CO1 ya existe",
        "El campo descripcion es obligatorio",
        "El campo direccion es obligatorio",
        "El campo movil es obligatorio",
        "El codigo 1 del campo codigo_pais no existe",
        "El codigo 76 del campo codigo_departamento no existe",
        "El codigo 76001 del campo codigo_ciudad no existe"
    ],
    "message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}

</Tab>

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

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": "CO1",
    "descripcion": "CENTRO DE OPERACION DEMO",
    "direccion": "CALLE 1 # 2-3",
    "codigo_pais": 1,
    "codigo_departamento": 76,
    "codigo_ciudad": 76001,
    "telefono": 1234567,
    "movil": "1234567890"
}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
id	int	11	Si	Identificador del centro de operación
abreviatura	string	11	Si	Abreviatura del centro de operación
descripcion	string	11	Si	Descripción del centro de operación
direccion	string	11	Si	Dirección del centro de operación
codigo_pais	int	11	Si	Código del país
codigo_departamento	int	11	Si	Código del departamento
codigo_ciudad	int	11	Si	Código de ciudad
telefono	int	11	No	Teléfono del centro de operación
movil	string	11	Si	Número de celular del centro de operación

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

{
    "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"
}

Validaciones

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo id es obligatorio",
        "La abreviatura CO1 ya esta asociado al id x",
        "El campo descripcion es obligatorio",
        "El campo direccion es obligatorio",
        "El campo movil es obligatorio",
        "El codigo 1 del campo codigo_pais no existe",
        "El codigo 76 del campo codigo_departamento no existe",
        "El codigo 76001 del campo codigo_ciudad no existe"
    ],
    "message": "Problemas de validaciones. 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/CentroOperacion")
  .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/CentroOperacion");
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/CentroOperacion');
$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>