API Documentos Contables/Proyectos

De WikiSerpi
Revisión del 10:22 21 jul 2023 de Dvaldes (discusión | contribs.) (Dvaldes trasladó la página API Documentos-Contables/Proyectos a API Documentos Contables/Proyectos)
(difs.) ← Revisión anterior | Revisión actual (difs.) | Revisión siguiente → (difs.)
Ir a la navegación Ir a la búsqueda

Descripción: Esta API permite la sincronización del agrupador de items definido como grupo 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/Proyectos

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/Proyectos?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": "24Y",
            "descripcion": "PEDIDO 024Y",
            "nit": "805000427",
            "nit_descripcion": "COOMEVA EPS",
            "activo": false,
            "notas": "null",
            "fecha_inicio": "2019-04-05",
            "fecha_fin": "2019-04-05",
            "tipoproyecto": 2,
            "id_centro_operacion": 1,
            "centro_operacion": "PRINCIPAL"
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}
Campos de resultados
Campo Tipo de dato Descripción
id int Identificador del proyecto
abreviatura string Abreviatura única para los proyectos
descripción string Descripción de los proyectos
nit string Identificador de los terceros
nit_descripcion string Descripción de los terceros
activo bool Estado del proyecto abierto o cerrado
notas string Notacion de los proyectos
fecha_inicio date Código de la categoría
fecha_fin date Descripción de la categoría
tipoproyecto int Identificador de los tipos de proyectos; Comercial, Maquila, Compras.
id_centro_operacion int Identificador de los centros de operaciones
centro_operacion string Descripción del centro de operación

</Tab>

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

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": "24Y",
    "descripcion": "PEDIDO 024Y",
    "nit": "805000427",
    "activo": true,
    "notas": "null",
    "fecha_inicio": "2019-04-05",
    "fecha_fin": "2019-04-05",
    "tipoproyecto": 2,
    "id_centro_operacion": 1
}


Campos del request
Campo Tipo de dato Longitud Requerido Descripción
abreviatura string 20 Si Abreviatura única para los proyectos
descripcion string 150 Si Descripción de los proyectos
nit int 11 Si Identificador de los terceros
activo bool 20 Si Código único de la categoría
notas string 150 No Estado del proyecto abierto o cerrado
fecha_inicio date YYYY-MM-DD Si Campos fechas
fecha_fin date YYYY-MM-DD Si Campos fechas
tipoproyecto int 11 Si Identificador de los tipos de proyectos; Comercial, Maquila, Compras.
id_centro_operacion int 11 No Identificador de los centros de operaciones

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": [
        "El campo descripción es obligatorio",
        "El id o el centro de operación 99 no existe",
        "El tipoproyecto 88 no existe",
        "El  Nit 8050004279 no existe",
        "La abreviatura 24Y ya existe",
        "El campo de fechafin es inválido. Formato esperado: yyyy-MM-dd"
    ],
    "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/Proyectos

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": "24Y",
    "descripcion": "PEDIDO 024Y",
    "nit": "805000427",
    "activo": true,
    "notas": "null",
    "fecha_inicio": "2019-04-05",
    "fecha_fin": "2019-04-05",
    "tipoproyecto": 2,
    "id_centro_operacion": 1
}


Campos del request
Campo Tipo de dato Longitud Requerido Descripción
id int 11 Si Identificador de los proyectos
abreviatura string 20 Si Abreviatura única para los proyectos
descripcion string 150 Si Descripción de los proyectos
nit int 11 Si Identificador de los terceros
activo bool 20 Si Código único de la categoría
notas string 150 No Estado del proyecto abierto o cerrado
fecha_inicio date YYYY-MM-DD Si Campos fechas
fecha_fin date YYYY-MM-DD Si Campos fechas
tipoproyecto int 11 Si Identificador de los tipos de proyectos; Comercial, Maquila, Compras.
id_centro_operacion int 11 No Identificador de los centros de operaciones

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 descripción es obligatorio",
        "El id o el centro de operación 99 no existe",
        "El tipoproyecto 88 no existe",
        "El  Nit 8050004279 no existe",
        "La abreviatura 24Y ya existe",
        "El campo de fechafin es inválido. Formato esperado: yyyy-MM-dd"
    ],
    "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/Proyectos")
  .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/Proyectos");
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/Proyectos');
$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_Documentos_Contables/Proyectos&oldid=846»