Diferencia entre revisiones de «API Ensambles»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
VisualWikitexto
Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Formulas entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas. '''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…»
 
Sin resumen de edición
 
Línea 391: Línea 391:
</Tab>
</Tab>
</Tabs>
</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
|}


== ¿Cómo consumir la API? ==
== ¿Cómo consumir la API? ==

Revisión actual - 10:17 30 oct 2023

Descripción: Esta API permite la sincronización del agrupador definido como Formulas entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas.

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

¿Cómo funciona?

  • El consumo de esta API se realiza por método GET.
  • 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 Tipos de Documento(GET)">

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

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,
            "categoriaDocumento": "ENS",
            "prefijo": "ENS",
            "descripcion": "ENSAMBLE"
        }
    ]
}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}
Campos de resultados
Campo Tipo de dato Descripción
id int Corresponde al identificador del tipo de documento
categoriaDocumento string Categoria del tipo de documento
prefijo string Prefijo del tipo de documento
descripcion string Descripcion del tipo de documento

</Tab>

<Tab name = "API Consultar Ensambles(GET) ">

EndPoint: https://www.apis.serpi.com.co/api/v1/Ensamble/ConsultarOP?limite=10&pagina=1&idTipoDocumento=1&numeroDesde=1&numeroHasta=100&fechaDesde=2023-07-01&fechaHasta=2023-08-31&idArticulo=10&estado=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 Requerido Descripción
Límite NO Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página 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
idTipoDocumento SI Id del tipo de documento (Api consulta tipos documento)
numeroDesde NO Numero inicial para filtrar por rango de numeros de documentos
numeroHasta NO Numero final para filtrar por rango de numeros de documentos
fechaDesde SI Fecha inicial para filtrar por rango de fecha del documento
fechaHasta SI Fecha final para filtrr por rango de fecha del documento
idArticulo NO Id del Articulo a filtrar
Estado NO 0=Pendiente, 2=Terminado


Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "prefijo": "ENS",
            "numeroDoc": 1,
            "fecha": "2023-08-29",
            "nitResponsable": "1234567890",
            "responsable": "RESPONSABLE1",
            "idArticulo": 744,
            "descripcion": "ENSAMBLE1",
            "cantidad": 5.00000,
            "idCentroOperacion": 1,
            "idBodega": 3,
            "idProyecto": null,
            "idCategoria": null,
            "estado": "Pendiente",
            "materiales": [
                {
                    "tipo": "C",
                    "idArticulo": 155,
                    "descripcion": "ARTICULO1",
                    "cantidad": 2.39295,
                    "porcCostoDesensamble": null
                },
                {
                    "tipo": "C",
                    "idArticulo": 158,
                    "descripcion": "ARTICULO2",
                    "cantidad": 0.22725,
                    "porcCostoDesensamble": null
                }
            ]
        }
    ]
}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}
Campos de resultados
Campo Tipo Descripción
id Int Corresponde al id del registro de Ensamble
prefijo String Prefijo del tipo de documento
numeroDoc Int Numero del Ensamble
nitResponsable String Numero de indentificacion del responsable del Ensamble
responsable String Nombre del responsable del Ensamble
idArticulo Int Id del articulo de Ensamble
descripcion String Descripcion del Articulo
cantidad Decimal cantidad a producir
fecha String Fecha del Ensamble
idCentroOperacion Int Id del centro de operacion
idBodega Int Id de la bodega
idProyecto Int Id del proyecto
idActividad Int Id de la Actividad
estado Int 0=Pendiente, 1=Terminado
materiales Array[ObjetoDetalle]* Array de objetos de los materiales del Ensamble

ObjetoDetalle

Campos de resultados
Campo Tipo Descripción
tipo String C=Componente, PT=Producto Terminado, PS=Producto Secundario
idArticulo Int Id del Articulo
descripcion String Descripcion del Articulo
cantidad Decimal Cantidad de los materiales
porcCostDesensamble Decimal Porcentaje destribucion de costos en desensambles

</Tab>

<Tab name = "API Crear (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/Ensamble

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 

[
    {
        "prefijo": "ENS",
        "numeroDoc": 12580,
        "fecha": "2023-08-31",
        "nitResponsable": "1151940703",
        "idArticulo": 744,
        "cantidad": 5.00000,
        "idCentroOperacion": 1,
        "idBodega": 3,
        "idBodegaMateriales": 3,
        "idProyecto": null,
        "idCategoria": null,
        "materiales": [
            {
                "tipo": "C",
                "idArticulo": 155,
                "descripcion": "Material1",
                "cantidad": 2.39295,
                "porcCostoDesensamble": null
            },
            {
                "tipo": "C",
                "idArticulo": 158,
                "descripcion": "Material2",
                "cantidad": 0.22725,
                "porcCostoDesensamble": null
            }
        ]
    }
]


Campos de resultados
Campo Tipo Requerido Descripción
prefijo String SI Prefijo del tipo de documento
numeroDoc Int SI Numero del Ensamble
nitResponsable String SI Numero de identificacion del responsable del Ensamble
idArticulo Int SI Id del Articulo del Ensamble
cantidad Decimal SI Cantidad a producir
fecha String SI Fecha del Ensamble
idCentroOperacion Int SI Id del Centro de Operacion
idBodega Int SI Id de la Bodega
idProyecto Int NO Id del Proyecto
idActividad Int NO Id de la Actividad
materiales Array[ObjetoDetalle]* Array de objetos de los materiales del Ensamble

ObjetoDetalle

Campos de resultados
Campo Tipo Requerido Descripción
tipo String SI C=Componente, PT=Producto Terminado, PS=Producto Secundario
idArticulo Int SI Id del Articulo
cantidad Decimal SI Cantidad de los materiales
porcCostDesensamble Decimal NO Porcentaje destribucion de costos en desensambles

Response 

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Se crearon 1 de 1 Ensambles"
}

</Tab>

<Tab name = "API Eliminar(DELETE) "> EndPoint: https://www.apis.serpi.com.co/api/v1/OP?idOP=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 Requerido Descripción
idOP NO id de la orden de produccion a eliminar )

Response 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se elimino correctamente la Orden de Produccion"
}

</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/Ensambles")
  .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/Ensambles");
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/Ensambles');
$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_Ensambles&oldid=1106»