Diferencia entre revisiones de «API Terceros/Grupo Ventas Compras»

Revisión del 11:16 27 may 2023

Descripción: Esta API permite la sincronizacion de Grupo Ventas Compras entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos herramientas.

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:

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

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

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/GrupoVentas?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": "RETENCION DEMO",
            "retenedor_rte_fuente": true,
            "base_rte_fuente": 1000.00,
            "retenedor_rte_ica": false,
            "base_min_rte_ica": 1000.00,
            "retenedor_iva": true,
            "base_rte_iva": 1000.00,
            "porcentaje_rte_ica": 1000.00,
            "porcentaje_rte_fuente": 1000.00,
            "porcentaje_rte_iva": 1000.00,
            "cuenta_rte_fuente": 1234567,
            "cuenta_rte_ica": 1234567,
            "cuenta_rte_iva": 1234567,
            "tipogrupo": 1,
            "aplica_iva_teorico": false,
            "base_iva_teorico": 1000.00,
            "porcentaje_iva_teorico": 1000.00,
            "cuenta_iva_teorico": 1234567,
            "cuenta_ret_iva_teorico": 1234567
        }
	]
}

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

Campos de resultados
Campo	Tipo de dato	Descripción
id	int	Corresponde al identificador del tipo de retención
descripcion	string	Descripción del tipo de retención
retenedor_rte_fuente	bool	Retenedor Rte Fuente
base_rte_fuente	double	Base Rte Fuente
retenedor_rte_ica	bool	Retenedor Rte ICA
base_min_rte_ica	double	Base Min Rte ICA
retenedor_iva	bool	Retenedor IVA
base_rte_iva	double	Retenedor IVA
porcentaje_rte_ica	double	Porcentaje Rte ICA
porcentaje_rte_fuente	double	Porcentaje Rte Fuente
porcentaje_rte_iva	double	Porcentaje Rte IVA
cuenta_rte_fuente	int	Cuenta Rte. Fuente
cuenta_rte_ica	int	Cuenta Rte. ICA
cuenta_rte_iva	int	Cuenta Rte. IVA
tipogrupo	int	Tipo de retención (Ventas o Compras)
aplica_iva_teorico	bool	Si aplica IVA teórico
base_iva_teorico	double	Base IVA teórico
porcentaje_iva_teorico	double	Porcentaje IVA teórico
cuenta_iva_teorico	int	Cuenta IVA teórico
cuenta_ret_iva_teorico	int	Cuenta Rte. IVA teórico

</Tab>

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

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": "Descripcion del tipo de retención",
    "retenedor_rte_fuente": true,
    "base_rte_fuente": 1000.00000,
    "retenedor_rte_ica": true,
    "base_min_rte_ica": 2000.00000,
    "retenedor_iva": true,
    "base_rte_iva": 3000.00000,
    "porcentaje_rte_ica": 5.00000,
    "porcentaje_rte_fuente": 10.00000,
    "porcentaje_rte_iva": 20.00000,
    "cuenta_rte_fuente": null,
    "cuenta_rte_ica": 1234567,
    "cuenta_rte_iva": 1234567,
    "tipogrupo": 1,
    "aplica_iva_teorico": true,
    "base_iva_teorico": 4000.00000,
    "porcentaje_iva_teorico": 30.00000,
    "cuenta_iva_teorico": 1234567,
    "cuenta_ret_iva_teorico": 1234567
}

Campos del request
Campo	Tipo de dato	Longitud	Requerido	Descripción
descripcion	string	50	Si	Descripción del tipo de retención
retenedor_rte_fuente	bool	1	No	Retenedor Rte Fuente
base_rte_fuente	double	(18,5)	No	Base Rte Fuente
retenedor_rte_ica	bool	1	No	Retenedor Rte ICA
base_min_rte_ica	double	(18,5)	No	Base Min Rte ICA
retenedor_iva	bool	1	No	Retenedor IVA
base_rte_iva	double	(18,5)	No	Retenedor IVA
porcentaje_rte_ica	double	(18,5)	No	Porcentaje Rte ICA
porcentaje_rte_fuente	double	(18,5)	No	Porcentaje Rte Fuente
porcentaje_rte_iva	double	(18,5)	No	Porcentaje Rte IVA
cuenta_rte_fuente	int	20	No	Cuenta Rte. Fuente
cuenta_rte_ica	int	20	No	Cuenta Rte. ICA
cuenta_rte_iva	int	20	No	Cuenta Rte. IVA
tipogrupo	int	1	Si	El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
aplica_iva_teorico	bool	1	No	Si aplica IVA teórico
base_iva_teorico	double	(18,5)	No	Base IVA teórico
porcentaje_iva_teorico	double	(18,5)	No	Porcentaje IVA teórico
cuenta_iva_teorico	int	20	No	Cuenta IVA teórico
cuenta_ret_iva_teorico	int	20	No	Cuenta Rte. IVA teórico

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": 201,
    "errors": null,
    "message": "registro creado exitosamente"
}

Validaciones

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo descripcion es obligatorio",
        "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
        "No existe una cuenta relacionada al numero auxiliar 1"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

</Tab>

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

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": "Descripcion del tipo de retención",
    "retenedor_rte_fuente": true,
    "base_rte_fuente": 1000.00000,
    "retenedor_rte_ica": true,
    "base_min_rte_ica": 2000.00000,
    "retenedor_iva": true,
    "base_rte_iva": 3000.00000,
    "porcentaje_rte_ica": 5.00000,
    "porcentaje_rte_fuente": 10.00000,
    "porcentaje_rte_iva": 20.00000,
    "cuenta_rte_fuente": null,
    "cuenta_rte_ica": 1234567,
    "cuenta_rte_iva": 1234567,
    "tipogrupo": 1,
    "aplica_iva_teorico": true,
    "base_iva_teorico": 4000.00000,
    "porcentaje_iva_teorico": 30.00000,
    "cuenta_iva_teorico": 1234567,
    "cuenta_ret_iva_teorico": 1234567
}

Campos del request
Campo	Tipo de dato	Longitud	Requerido	Descripción
id	int	11	Si	Corresponde al identificador del tipo de retención
descripcion	string	50	Si	Descripción del tipo de retención
retenedor_rte_fuente	bool	1	No	Retenedor Rte Fuente
base_rte_fuente	double	(18,5)	No	Base Rte Fuente
retenedor_rte_ica	bool	1	No	Retenedor Rte ICA
base_min_rte_ica	double	(18,5)	No	Base Min Rte ICA
retenedor_iva	bool	1	No	Retenedor IVA
base_rte_iva	double	(18,5)	No	Retenedor IVA
porcentaje_rte_ica	double	(18,5)	No	Porcentaje Rte ICA
porcentaje_rte_fuente	double	(18,5)	No	Porcentaje Rte Fuente
porcentaje_rte_iva	double	(18,5)	No	Porcentaje Rte IVA
cuenta_rte_fuente	int	20	No	Cuenta Rte. Fuente
cuenta_rte_ica	int	20	No	Cuenta Rte. ICA
cuenta_rte_iva	int	20	No	Cuenta Rte. IVA
tipogrupo	int	1	Si	El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
aplica_iva_teorico	bool	1	No	Si aplica IVA teórico
base_iva_teorico	double	(18,5)	No	Base IVA teórico
porcentaje_iva_teorico	double	(18,5)	No	Porcentaje IVA teórico
cuenta_iva_teorico	int	20	No	Cuenta IVA teórico
cuenta_ret_iva_teorico	int	20	No	Cuenta Rte. IVA teórico

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": null,
    "message": "registro modificado exitosamente"
}

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

Validaciones

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo id es obligatorio",
        "El campo descripcion es obligatorio",
        "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
        "No existe una cuenta relacionada al numero auxiliar 1"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

</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();
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>

@@ Línea 1: / Línea 1: @@
 '''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 la sincronizacion de Grupo Ventas Compras entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos herramientas.
 '''Autorización:'''
@@ Línea 6: / Línea 6: @@
 '''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:'''
@@ Línea 12: / Línea 11: @@
 '''¿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.

Diferencia entre revisiones de «API Terceros/Grupo Ventas Compras»

Revisión del 11:16 27 may 2023

Sumario

Métodos

AVISO IMPORTANTE:

AVISO IMPORTANTE:

Códigos de estado HTTP

¿Cómo consumir la API?

Menú de navegación

Diferencia entre revisiones de «API Terceros/Grupo Ventas Compras»

Revisión del 11:16 27 may 2023

Métodos

AVISO IMPORTANTE:

AVISO IMPORTANTE:

Códigos de estado HTTP

¿Cómo consumir la API?

Menú de navegación

Buscar