API Terceros/Categoria Terceros

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

<Tabs> <Tab name = "API Consulta (GET) "> GET/users

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

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/CategoriaTercero?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,
	"message": "x registro(s) encontrados",
	"result": [
		{
			 "id": 1,
            "descripcion": "TERCEROS",
            "cxc_cliente": 13050501,
            "descripcion_cxc_cliente": "CLIENTES INSTITUCIONALES",
            "cxc_proveedor": 22050501,
            "descripcion_cxc_proveedor": "PROVEEDORES NACIONALES"

		}
	]
}

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

Campo de resultados

Campo	Tipo de dato	Descripción
Id	int	Corresponde al identificador la categoría tercero
Descripcion	string	Describe la categoría.
cxc_cliente	int	Corresponde al código de la cuenta
cxc_proveedor	string	Corresponde al código de la cuenta

</Tab>

<Tab name = "API Creación (POST) "> POST

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

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

{
   "descripcion": "TERCERO EXTERIOR 100",
   "cxc_cliente": 11050501,
   "cxc_proveedor": 22100101

}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
descripcion	string	100	SI	Describe la categoría del tercero
cxc_cliente	int	20	SI	Cuenta Por Cobrar Cliente
cxc_proveedor	int	20	SI	Cuenta Por Pagar Proveedor

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
	"success": true,
    "code": 201,
    "errors": null,
    "message": "registro creado exitosamente"

}
{
    "success": false,
    "code": 400,
    "errors": [
        "El campo descripcion es obligatorio",
        "El campo cxc_cliente 1105050 no existe",
        "El campo cxc_proveedor 2210010 no existe"
    ],
    "message": "Se presentaron errores al crear el registro"
}

</Tab>

<Tab name = "API Modificar(PUT) "> PUT

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

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
   "descripcion": "categoria terceros ",
   "cxc_cliente": 11050501,
   "cxc_proveedor": 11050501

}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
id	int	11	SI	Hace referencia al id que vamos a hacer la edición
descripcion	string	50	SI	Describe la categoría del tercero
cxc_cliente	int	20	SI	Cuenta Por Cobrar Cliente
cxc_proveedor	int	20	SI	Cuenta Por Pagar Proveedor

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
  "success": true
  "code": 200,
  "errors": null,
  "message": "registro modificado exitosamente"
}

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo descripcion es obligatorio",
        "El campo cxc_cliente 110505019 no existe",
        "El campo cxc_proveedor 110505019 no existe"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

{
    	"success": false,
    	"code": 204,
    	"errors": null,
    	"message": "No se encontraron registros con el id xx"
}

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

Observaciones

Campos	Descripción
cxc_cliente	Cuenta Por Cobrar Cliente ,se bebe enviar el numero de la cuenta como, 11050501
cxc_proveedor	Cuenta Por Pagar Proveedor ,se bebe enviar el numero de la cuenta como ,11050200
id	NO se debe enviar el numero identificador de la cuenta.