API Ordenes de Producción

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

Descripción: Esta API permite la sincronización del agrupador definido como Ordenes de Produccion 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 Tipo 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": "2 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "categoriaDocumento": "OP",
            "prefijo": "OP",
            "descripcion": "ORDEN DE PRODUCCION"
        }
    ]
}

{
    "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 Ordenes de Producción(GET) ">

EndPoint: https://www.apis.serpi.com.co/api/v1/OP/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 1=En Proceso, 2=Terminado


Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1818,
            "prefijo": "OP",
            "numeroDoc": 1,
            "idArticulo": 10,
            "articulo": "ARTICULO1",
            "fecha": "2023-06-23",
            "autor": "USUARIO1",
            "cantidad": 10000.00000,
            "cantPendiente": 7000.00000,
            "cantEnsambles": 2,
            "estado": "En Proceso",
            "ensambles": [
                {
                    "prefijo": "ENS",
                    "numeroDoc": 1,
                    "fecha": "2023-07-12",
                    "autor": "USUARIO2",
                    "cantidad": 1500.00000,
                    "estado": "Terminado"
                },
                {
                    "prefijo": "ENS",
                    "numeroDoc": 2,
                    "fecha": "2023-06-30",
                    "autor": "USUARIO2",
                    "cantidad": 1500.00000,
                    "estado": "Terminado"
                }
            ]
        }
    ]
}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}
Campos de resultados
Campo Tipo Descripción
id Int Corresponde al id del registro
prefijo String Prefijo del tipo de documento
numeroDoc Int Numero de la orden de produccion
idArticulo Int Id del Articulo
articulo String Descripcion del Articulo
fecha String Fecha de la orden de produccion
autor String Usuario quien crea la orden de produccion
cantidad Decimal cantidad a producir
cantidadPendiente Decimal Cantidad Pendiente
cantEnsambles Int Cantidad de ensambles asociados a la orden de produccion
Estado String Estado de la orden de produccion
ensambles Array[ObjetoDetalle]* Array de objetos de los ensambles la orden de produccion

ObjetoDetalle

Campos de resultados
Campo Tipo Descripción
prefijo String Prefijo del tipo de documento del ensamble
numeroDoc Int Numero del ensamble
fecha String Fecha del ensamble
autor String Usuario quien crea el ensamble
cantidad Decimal Cantidad del ensamble
Estado String Estado del ensamble

</Tab>

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

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": "OP",
        "numeroDoc": 1,
        "idArticulo": 10,
        "fecha": "2023-08-29",
        "cantidad": 100
    },
    {
        "prefijo": "OP",
        "numeroDoc": 2,
        "idArticulo": 11,
        "fecha": "2023-08-29",
        "cantidad": 220
    }
]


Campos de resultados
Campo Tipo Requerido Descripción
prefijo String SI Prefijo del tipo de documento
numeroDoc Int SI Numero de la orden de produccion
idArticulo Int SI Id del Articulo
cantidad Decimal SI Cantidad a producir

Response 

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

</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/OP")
  .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/OP");
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/OP');
$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_Ordenes_de_Producción&oldid=1108»