API Terceros/Tipo Identidad

De WikiSerpi
Revisión del 16:13 24 may 2023 de Gpazos (discusión | contribs.) (Created page with "'''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 au...")
(difs.) ← Revisión anterior | Revisión actual (difs.) | Revisión siguiente → (difs.)
Ir a la navegación Ir a la búsqueda

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. Se recomienda utilizar un token de acceso de OAuth2.

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 tabSelectedStyle="color:red;" tabStyle="color:blue;"> <Tab name = "API Consulta (GET) "> URL: URL: https://localhost:44305/api/v1/TipoIdentidad?limite=4&pagina=2

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

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

Response 

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

URL: https://localhost:44305/api/v1/TipoIdentidad?limite=4&pagina=2

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

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

Response 

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

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

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

Response 

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

</Tab>

<Tab name = "API Creación (POST) "> POST /users URL: URL: https://localhost:44305/api/v1/TipoIdentidad?limite=4&pagina=2

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

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

Response 

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

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

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

Response 

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

</Tab>

<Tab name = "API Modificación (PUT)"> PUT /users/{id} Actualiza los datos de un usuario existente.

Parámetros id (requerido) - ID del usuario que se va a actualizar. nombre (opcional) - nuevo nombre del usuario. apellido (opcional) - nuevo apellido del usuario. email (opcional) - nueva dirección de correo electrónico del usuario. fecha_nacimiento (opcional) - nueva fecha de nacimiento del usuario (en formato ISO 8601, por ejemplo: "1980-01-01"). activo (opcional) - si el usuario está activo o no.

Respuesta HTTP/1.1 200 OK Content-Type: application/json

{ 

 "id": 3,
 "nombre": "Pedro",
 "apellido": "Garcia",
 "email": "pedro.garcia@example.com",
 "fecha_nacimiento": "1985-05-05",
 "activo": true

} </Tab>

<Tab name = "Probar API"> Contenido del probar API </Tab>

</Tabs>

¿Cómo consumir la API?

<Tabs>

<Tab name = "Java"> Request 

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}")
  .method("GET", null)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

Response 

{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

</Tab>

<Tab name = "Python"> Request 

import requests

url = "https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}"

payload={}
headers = {
  'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response 

{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

</Tab>

</Tabs>

Posibles códigos de respuesta 200, 400, 401, 403, 404, 405

Obtenido de «https://www.wikiserpi.com/index.php?title=API_Terceros/Tipo_Identidad&oldid=9»