API Terceros/Zonas - Historial de revisiones

Nalzate en 13:59 30 oct 2023

2023-10-30T13:59:35Z

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

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

2023-06-20T19:34:40Z

¿Cómo consumir la API?

Mostrar los cambios

Dvaldes: /* Métodos */

2023-06-08T19:35:57Z

Métodos

← Revisión anterior		Revisión del 15:35 8 jun 2023
Línea 61:		Línea 61:
	"descripcion": "BOGOTA",		"descripcion": "BOGOTA",
	"id_vendedor": "3173988",		"id_vendedor": "3173988",
	"id_cobrador": "3173988"		"descripcion_vendedor": "DESCRIPCIÓN DEL VENDEDOR",
			"id_cobrador": "3173988",
			"descripcion_cobrador": "DESCRIPCIÓN DEL COBRADOR"
	}		}
	]		]
Línea 85:		Línea 87:
	\|-		\|-
	\| vendedorid \|\| int \|\| Corresponde al identificador del vendedor		\| vendedorid \|\| int \|\| Corresponde al identificador del vendedor
			\|-
			\| descripcion_vendedor \|\| string \|\| Descripción del vendedor
	\|-		\|-
	\| cobradorid \|\| int \|\| Corresponde al identificador del cobrador		\| cobradorid \|\| int \|\| Corresponde al identificador del cobrador
			\|-
			\| descripcion_cobrador \|\| string \|\| Descripción del cobrador
	\|}		\|}
	</Tab>		</Tab>

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

2023-06-01T15:36:42Z

¿Cómo consumir la API?

@@ Línea 255: / Línea 255: @@
 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}}")
+   .url("https:///www.apis.serpi.com.co/api/v1/Zona")
-   .method("GET", null)
+   .method("GET", body)
-   .addHeader("wolkvox-token", "{{token}}")
+   .addHeader("secretkey", "{Secret Key}")
    .build();
 Response response = client.newCall(request).execute();
@@ Línea 286: / Línea 289: @@
 import requests
-url = "https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}"
+url = "https://www.apis.serpi.com.co/api/v1/Zona"
-payload={}
+payload = {}
 headers = {
-   'wolkvox-token': '{{token}}'
+   'secretkey': '{Secret Key}',
+}
@@ Línea 296: / Línea 300: @@
 print(response.text)
 </syntaxhighlight>

Gpazos en 21:31 26 may 2023

2023-05-26T21:31:18Z

← Revisión anterior		Revisión del 17:31 26 may 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 códigos de zonas definidas en SERPI con el fin de agrupar clientes.

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

	'''Beneficio:'''		'''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)~~		Permite el manejo estándar de códigos de zonas entre SERPI y la plataforma integrada.

	'''Tipos de peticiones:'''		'''Tipos de peticiones:'''
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.

Nalzate: /* Métodos */

2023-05-26T20:22:11Z

Métodos

← Revisión anterior		Revisión del 16:22 26 may 2023
Línea 59:		Línea 59:
	"result": [		"result": [
	{		{
	"id": 1,		"id": 2,
	"abreviatura": "1",		"abreviatura": "2",
	"descripcion": "BOGOTA",		"descripcion": "BOGOTA",
	"~~gdtvendedorid~~": ~~4356~~,		"id_vendedor": "3173988",
	"~~gdtcobradorid~~": ~~4356~~		"id_cobrador": "3173988"
	}		}
	]		]
Línea 115:		Línea 115:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	"abreviatura": "3",		"id": 2,
	"descripcion": "~~MEDELLIN~~",		"abreviatura": "2",
	"~~gdtvendedorid~~": ~~5560~~,		"descripcion": "BOGOTA",
	"~~gdtcobradorid~~": ~~5560~~		"id_vendedor": "3173988",
			"id_cobrador": "3173988"
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 149:		Línea 150:
	"result": [		"result": [
	{		{
	"abreviatura": "3",		"id": 2,
	"descripcion": "~~MEDELLIN~~",		"abreviatura": "2",
	"~~gdtvendedorid~~": ~~5560~~,		"descripcion": "BOGOTA",
	"~~gdtcobradorid~~": ~~5560~~		"id_vendedor": "3173988",
	}		"id_cobrador": "3173988"
			}
	]		]
	}		}
Línea 189:		Línea 191:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	"abreviatura": "3",		"id": 2,
	"descripcion": "~~MEDELLIN~~",		"abreviatura": "2",
	"~~gdtvendedorid~~": ~~5560~~,		"descripcion": "BOGOTA",
	"~~gdtcobradorid~~": ~~5560~~		"id_vendedor": "3173988",
			"id_cobrador": "3173988"
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 207:		Línea 210:
	\|-		\|-
	\| cobradorid \|\| int \|\| 50 \|\| SI \|\| Identificador del cobrador		\| cobradorid \|\| int \|\| 50 \|\| SI \|\| Identificador del cobrador
	\|-
	~~\| abreviatura3 \|\| string \|\| 50 \|\| NO \|\| Abreviatura3 Tipo de identidad~~
	\|}		\|}

Nalzate: /* Métodos */

2023-05-25T15:04:53Z

Métodos

← Revisión anterior		Revisión del 11:04 25 may 2023
Línea 200:		Línea 200:
	! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción		! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
	\|-		\|-
	\| id \|\| ~~int~~ \|\| 50 \|\| SI \|\| ~~Corresponde al identificador del tipo~~ de ~~identidad~~		\| abreviatura \|\| string \|\| 50 \|\| SI \|\| Abreviatura de Zona
	\|-		\|-
	\| ~~abreviatura~~ \|\| string \|\| 50 \|\| SI \|\| ~~Abreviatura Tipo~~ de ~~identidad~~		\| descripcion\|\| string \|\| 50 \|\| SI \|\| Descripcion de Zona
	\|-		\|-
	\| ~~descripcion~~\|\| ~~string~~ \|\| 50 \|\| SI \|\| ~~Descripcion tipo de identidad~~		\| vendedorid \|\| int \|\| 50 \|\| SI \|\| Identificador del vendedor
	\|-		\|-
	\| ~~codigo~~ \|\| int \|\| 50 \|\| SI \|\| ~~Codigo numero~~ del ~~tipo de identidad~~		\| cobradorid \|\| int \|\| 50 \|\| SI \|\| Identificador del cobrador
	\|-
	~~\| abreviatura2 \|\| string \|\| 50 \|\| NO \|\| Abreviatura2 Tipo de identidad~~
	\|-		\|-
	\| abreviatura3 \|\| string \|\| 50 \|\| NO \|\| Abreviatura3 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~~
	\|}		\|}

Nalzate: /* Métodos */

2023-05-25T14:58:17Z

Métodos

← Revisión anterior		Revisión del 10:58 25 may 2023
Línea 132:		Línea 132:
	\| vendedorid \|\| int \|\| 50 \|\| SI \|\| identificador del vendedor		\| vendedorid \|\| int \|\| 50 \|\| SI \|\| identificador del vendedor
	\|-		\|-
	\| cobradorid \|\| int \|\| 50 \|\| NO \|\| identificador del cobrador		\| cobradorid \|\| int \|\| 50 \|\| SI \|\| identificador del cobrador
	\|}		\|}

Línea 149:		Línea 149:
	"result": [		"result": [
	{		{
	~~"id": 1,~~		"abreviatura": "3",
	"abreviatura": "CC",		"descripcion": "MEDELLIN",
	"descripcion": "~~CEDULA CIUDADANIA",~~		"gdtvendedorid": 5560,
	~~"codigo": 13,~~		"gdtcobradorid": 5560
	~~"abreviatura2": "~~",
	"~~abreviatura3~~": ~~null~~,
	"~~excluirImpVentas~~": ~~null~~
	}		}
	]		]
Línea 192:		Línea 189:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	~~"id": 1~~		"abreviatura": "3",
	"abreviatura": "~~NIT~~",		"descripcion": "MEDELLIN",
	"descripcion": "~~NIT~~",		"gdtvendedorid": 5560,
	"~~codigo~~": ~~31,~~		"gdtcobradorid": 5560
	~~"abreviatura2": " NIT2",~~
	~~"abreviatura3": ""~~,
	"~~excluirImpVentas~~": ~~false~~
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Nalzate: /* Métodos */

2023-05-25T14:46:52Z

Métodos

← Revisión anterior		Revisión del 10:46 25 may 2023
Línea 60:		Línea 60:
	{		{
	"id": 1,		"id": 1,
	~~"gdtempresaid": 1,~~
	"abreviatura": "1",		"abreviatura": "1",
	"descripcion": "BOGOTA",		"descripcion": "BOGOTA",
Línea 81:		Línea 80:
	! Campo !! Tipo de dato !! Descripción		! Campo !! Tipo de dato !! Descripción
	\|-		\|-
	\| Id \|\| int \|\| Corresponde al identificador ~~del tipo~~ de ~~identidad~~		\| id \|\| int \|\| Corresponde al identificador de la zona
	\|-		\|-
	\| abreviatura \|\| string \|\| Abreviatura ~~Tipo~~ de ~~identidad~~		\| abreviatura \|\| string \|\| Abreviatura de Zona
	\|-		\|-
	\| descripcion \|\| string \|\| Descripción ~~tipo de identidad~~		\| descripcion \|\| string \|\| Descripción Zona
	\|-		\|-
	\| ~~codigo~~ \|\| int \|\| ~~Código numero~~ del ~~tipo de identidad~~		\| vendedorid \|\| int \|\| Corresponde al identificador del vendedor
	\|-		\|-
	\| ~~abreviatura2~~ \|\| ~~string~~ \|\| ~~Abreviatura2 Tipo de identidad~~		\| cobradorid \|\| int \|\| Corresponde al identificador del cobrador
	\|-
	~~\| abreviatura3 \|\| string \|\| Abreviatura3 Tipo de identidad~~
	\|-
	~~\| excluirImpVentas \|\| bool \|\| True o False. Si el tipo de identidad es excluido~~ del ~~impuesto de ventas~~
	\|}		\|}
	</Tab>		</Tab>
Línea 102:		Línea 97:

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

	''' Headers '''		''' Headers '''
Línea 120:		Línea 115:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	~~"id": 3,~~
	"abreviatura": "3",		"abreviatura": "3",
	"descripcion": "MEDELLIN",		"descripcion": "MEDELLIN",
Línea 132:		Línea 126:
	! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción		! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
	\|-		\|-
	\| abreviatura \|\| string \|\| 50 \|\| SI \|\| Abreviatura ~~Tipo de identidad~~		\| abreviatura \|\| string \|\| 50 \|\| SI \|\| Abreviatura Zona
	\|-
	~~\| 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~~		\| descripcion\|\| string \|\| 50 \|\| SI \|\| Descripcion tipo de Zona
	\|-		\|-
	\| ~~abreviatura3~~ \|\| ~~string~~ \|\| 50 \|\| NO \|\| ~~Abreviatura3 Tipo de identidad~~		\| vendedorid \|\| int \|\| 50 \|\| SI \|\| identificador del vendedor
	\|-		\|-
	\| ~~excluirImpVentas~~\|\| ~~bool~~ \|\| 50 \|\| NO \|\| ~~true o false. Si el tipo de identidad es excluido~~ del ~~impuesto de ventas~~		\| cobradorid \|\| int \|\| 50 \|\| NO \|\| identificador del cobrador
	\|}		\|}

Nalzate: /* Métodos */

2023-05-25T14:37:39Z

Métodos

← Revisión anterior		Revisión del 10:37 25 may 2023
Línea 18:		Línea 18:

	== Métodos ==		== Métodos ==
	<~~Tabs~~>		<tabs>
	<!-- *************** GET **************** -->		<!-- *************** GET **************** -->
	<Tab name = "API Consulta (GET) ">		<Tab name = "API Consulta (GET) ">
Línea 24:		Línea 24:

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

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

	''' Headers '''		''' Headers '''
Línea 59:		Línea 59:
	"result": [		"result": [
	{		{
	"id": 1,		"id": 1,
	"~~abreviatura~~": ~~"CC"~~,		"gdtempresaid": 1,
	"~~descripcion~~": "~~CEDULA CIUDADANIA~~",		"abreviatura": "1",
	"~~codigo": 13,~~		"descripcion": "BOGOTA",
	~~"abreviatura2~~": "",		"gdtvendedorid": 4356,
	"~~abreviatura3~~": ~~null~~,		"gdtcobradorid": 4356
	"~~excluirImpVentas~~": ~~null~~		}
	}
	]		]
	}		}
Línea 121:		Línea 120:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	"~~abreviatura~~": ~~"NIT"~~,		"id": 3,
	"~~descripcion~~": "~~NIT~~",		"abreviatura": "3",
	"~~codigo": 31,~~		"descripcion": "MEDELLIN",
	~~"abreviatura2~~": " ~~NIT2~~",		"gdtvendedorid": 5560,
	"~~abreviatura3~~": "",		"gdtcobradorid": 5560
	"~~excluirImpVentas~~": ~~false~~
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 267:		Línea 265:
	</syntaxhighlight>		</syntaxhighlight>
	</Tab>		</Tab>
	</~~Tabs~~>		</tabs>

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