Nalzate en 14:03 30 oct 2023

2023-10-30T14:03:25Z

@@ Línea 223: / Línea 223: @@
 </Tab>
 </Tabs>
 == ¿Cómo consumir la API? ==

Nalzate: /* ¿Cómo consumir la API? */

2023-06-20T19:36:22Z

¿Cómo consumir la API?

Mostrar los cambios

Gpazos en 01:36 5 jun 2023

2023-06-05T01:36:07Z

← Revisión anterior		Revisión del 20:36 4 jun 2023
Línea 1:		Línea 1:
	'''Descripción:'''		'''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~~.		Esta API permite sincronizar los bancos definidos en SERPI con con la plataforma que lo requiera.

	'''Autorización:'''		'''Autorización:'''
Línea 12:		Línea 12:

	'''¿Cómo funciona?'''		'''¿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.		*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.		*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Lmedina: /* ¿Cómo consumir la API? */

2023-05-25T15:05:00Z

¿Cómo consumir la API?

@@ Línea 293: / Línea 293: @@
+     ]
+}
 </syntaxhighlight>
 </Tab>

Lmedina: /* Métodos */

2023-05-25T14:39:55Z

Métodos

Mostrar los cambios

Gpazos: 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..."

2023-05-25T14:08:54Z

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..."

Página nueva

'''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/TipoIdentidad

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/TipoIdentidad?limite=50&pagina=1

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! 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'''
<syntaxhighlight lang="JSON" line="1">
{
"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": []
}
</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! 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'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"abreviatura": "NIT",
"descripcion": "NIT",
"codigo": 31,
"abreviatura2": " NIT2",
"abreviatura3": "",
"excluirImpVentas": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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": []
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT/users'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1
"abreviatura": "NIT",
"descripcion": "NIT",
"codigo": 31,
"abreviatura2": " NIT2",
"abreviatura3": "",
"excluirImpVentas": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador del tipo de identidad
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "registro modificado exitosamente"
}

{
"success": false,
"code": 400,
"errors": [
"El campo abreviatura es obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id xx"
}
</syntaxhighlight>
</Tab>
</Tabs>

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

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
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();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
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)
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</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
|}

[[Category:Documentación APIs]]

API Terceros/Bancos - Historial de revisiones

Nalzate en 14:03 30 oct 2023

Nalzate: /* ¿Cómo consumir la API? */

Gpazos en 01:36 5 jun 2023

Lmedina: /* ¿Cómo consumir la API? */

Lmedina: /* Métodos */