API Terceros/Lista Precios Detalle

Descripción: Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

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: Este reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

El consumo de esta API se realiza por método GET.
Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
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

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

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle?limite=50&pagina=1&idArticulo=1&idListaPrecio=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
limite	int	No	Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
pagina	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
idArticulo	int	No	Este parámetro indica el id del artículo que desea consultar
idListaPrecio	int	No	Este parámetro trae la consulta de los artículos relacionados al id de la lista precio que desee consultar

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id_listaprecio": 1,
            "descripcion_id_listaprecio": "DESCRIPCION DE LA LISTA DE PRECIO",
            "id_articulo": 1,
            "descripcion_articulo": "ARTICULO DEMO",
            "precio": 0,
            "descuento": 0,
            "observaciones": "OBSERVACIONES GENERALES"
        }
	]
}

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

Campos de resultados
Campo	Tipo de dato	Descripción
id_listaprecio	int	Identificador de la lista precio relacionada al detalle
descripcion_id_listaprecio	string	Descripción de la lista precio relacionada al detalle
id_articulo	int	Identificador del articulo relacionado al detalle
descripcion_articulo	string	Descripción del artículo
precio	double	Precio del artículo
descuento	double	Descuento del artículo
observaciones	string	Observaciones de la lista de precio detalle

</Tab>

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

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_listaprecio": 1,
        "id_articulo": 1000,
        "precio": 50000,
        "descuento": 10,
        "observaciones": "OBSERVACIÓN GENERAL"
    },
    .
    .
    .
    {
        "id_listaprecio": n,
        "id_articulo": n,
        "precio": 0,
        "descuento": 0,
        "observaciones": null
    }
]

Campos del request
Campo	Tipo de dato	Longitud	Requerido	Descripción
id_listaprecio	int	11	Si	Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
id_articulo	int	11	Si	Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
precio	double	(18,5)	Si	Precio del artículo
descuento	double	(18,5)	No	Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
observaciones	string	500	No	Observaciones de la lista de precio detalle

AVISO IMPORTANTE:

Donde los campos no sean obligatorios y no se desea asignar algún valor, pruebe digitando null o 0 en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite null.

Response

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

Validaciones

{
    "success": true,
    "code": 201,
    "errors": [
        "El campo precio es obligatorio",
        "El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
        "No existe un articulo relacionado al id 0",
        "No existe una lista de precio relacionada al id 0"
    ],
    "message": "Se crearon 0 de 1 lista precio detalle"
}

</Tab>

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

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_listaprecio": 1000,
        "id_articulo": 10000,
        "precio": 0,
        "descuento": 0,
        "observaciones": "OBSERVACIONES GENERALES"
    },
    .
    .
    .
    {
        "id_listaprecio": n,
        "id_articulo": n,
        "precio": 0,
        "descuento": 0,
        "observaciones": null
    }
]

Campos del request
Campo	Tipo de dato	Longitud	Requerido	Descripción
id_listaprecio	int	11	Si	Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
id_articulo	int	11	Si	Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
precio	double	(18,5)	Si	Precio del artículo
descuento	double	(18,5)	No	Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
observaciones	string	500	No	Observaciones de la lista de precio detalle

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": "Se modificaron 1 de 1 lista precios detalle"
}

Validaciones

{
    "success": true,
    "code": 200,
    "errors": [
        "Lista Precio Detalle 1:  El id no existe",
        "El campo precio es obligatorio",
        "El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
        "No existe un articulo relacionado al id 10000",
        "No existe una lista de precio relacionada al id 1000"
    ],
    "message": "Se modificaron 0 de 1 lista precios detalle"
}

</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/ListaPrecioDetalle")
  .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/ListaPrecioDetalle");
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/ListaPrecioDetalle');
$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>

API Terceros/Lista Precios Detalle

Sumario

Métodos

AVISO IMPORTANTE:

AVISO IMPORTANTE:

Códigos de estado HTTP

¿Cómo consumir la API?

Menú de navegación

API Terceros/Lista Precios Detalle

Métodos

AVISO IMPORTANTE:

AVISO IMPORTANTE:

Códigos de estado HTTP

¿Cómo consumir la API?

Menú de navegación

Buscar