Diferencia entre revisiones de «API Articulos/Lineas»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
Edición siguiente →
VisualWikitexto
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..."
 
m Replaced content with "<ul class="accordion"> <li> <div class="tab">Pestaña 1</div> <div class="content"> Contenido de la pestaña 1. </div> </li> <li> <div class="tab">Pestaña 2</div> <div class="content"> Contenido de la pestaña 2. </div> </li> <!-- Agrega más pestañas según sea necesario --> </ul>"
Etiqueta: Reemplazo
Línea 1: Línea 1:
'''Descripción:'''
<ul class="accordion">
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.
  <li>
 
     <div class="tab">Pestaña 1</div>
'''Autorización:'''
    <div class="content">
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.
      Contenido de la pestaña 1.
 
     </div>
'''Beneficio:'''
  </li>
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)
  <li>
 
    <div class="tab">Pestaña 2</div>
'''Tipos de peticiones:'''
     <div class="content">
GET, POST, PUT
      Contenido de la pestaña 2.
 
     </div>
'''¿Cómo funciona?'''
  </li>
*El consumo de esta API se realiza por método GET.
   <!-- Agrega más pestañas según sea necesario -->
*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.
</ul>
*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>
<!-- ***************** GET ****************** -->
<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/Tercero?limite=50&pagina=1&identificacion=123456789&fechaCreadoDesde=2020-01-01%2000:00:00&fechaCreadoHasta=2020-12-31%2023:59:59
 
''' 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
|-
| Identificacion || int || No || Cedula o nit del tercero a filtrar
|-
| FechaCreadoDesde || Date || No || Fecha inicial para filtrar por fecha de creación del tercero
|-
| FechaCreadoHasta || Date || No || Fecha final para filtrar por fecha de creación del tercero
|}
 
'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
            "id": 1,
            "tipoidentidad": "CC",
            "identificacion": "123456789",
            "dv": 0,
            "tipopersona": 2,
            "primernombre": "PEDRO",
            "segundonombre": "LUIS",
            "primerapellido": "PEREZ",
            "segundoapellido": "LOPEZ",
            "nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
            "razonsocial": null,
            "escliente": true,
            "esproveedor": true,
            "esempleado": false,
            "esvendedor": false,
            "esotro": false,
            "escobrador": false,
            "cumple_dia": 0,
            "cumplea_mes": 0,
            "cumplea_ano": 0,
            "genero": "N",
            "direccion": "CRA 1 25 05",
            "direccion2": null,
            "telefono": null,
            "ext": 0,
            "movil": null,
            "pais": "COLOMBIA",
            "departamento": "VALLE",
            "ciudad": "SANTIAGO DE CALI",
            "codciudad": "76001",
            "zona": 0,
            "email": "prueba@mail.com",
            "activo": true,
            "cupocredito": 0.00,
            "periodopago": 0,
            "codigociiu": null,
            "descuentoventa": 0,
            "categoriatercero": 1,
            "formapago": 0,
            "listaprecios": 2,
            "grupoventas": 1,
            "grupocompras": 2,
            "vendedor": 0,
            "cobrador": 0,
            "fechacreacion": "2020-01-04 10:16:30",
            "regimen": 2,
            "banco": 0,
            "tipo_cuenta": null,
            "cuenta_bancaria": null,
            "limite_credito": 0.00000,
            "camposcliente": {
                "ACTIVIDADECONOMICAMUNICIPAL": "BC44",
                "Comentarios": "Cliente proveedor de software",
                "Comuna": 11,
                "FechaAniversario": "2016-06-01",
                "ClienteNacional": true,
                "Ranking": "2",
                "TieneAsesor": "N",
                "Vetado": "3",
                "TipodeEmpresa": [
                    "b",
                    "c"
                ],
                "continente": ""
            }
 
]
}
 
{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}
 
{
     "success": false,
    "code": 400,
    "message": "El formato de las fechas es invalido. Ejemplo 2023-01-20 00:00:00",
}
 
</syntaxhighlight>
 
 
 
 
'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador del tercero
|-
| tipoidentidad || string || Codigo del tipo de indentidad
|-
| identificacion || string || Numero de identificacion
|-
| dv || int || Digito de verificacion
|-
| tipopersona || int || Codigo del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || string || Primer nombre
|-
| segundonombre || bool || Segundo nombre
|-
| primerapellido || string || Primer apellido
|-
| segundoapellido || string || Segundo apellido
|-
| nombrecompleto || string || Nombre completo
|-
| razonsocial || string || razon social
|-
| escliente || bool || Seleccionar si el tercero es cliente
|-
| esproveedor || bool || Seleccionar si el tercero es proveedor
|-
| esempleado || bool || Seleccionar si el tercero es empleado
|-
| esvendedor || bool || Seleccionar si el tercero es vendedor
|-
| esotro || bool || Seleccionar si el tercero es otro
|-
| escobrador || bool || Seleccionar si el tercero es cobrador
|-
| cumple_dia || int || Dia del cumpleaños
|-
| cumplea_mes || int || Mes del cumpleaños
|-
| cumplea_ano || int || Año del cumpleaños
|-
| genero || string || Genero del tercero (M=Masculino, F=Femenino)
|-
| direccion || string || Direccion
|-
| direccion2 || string || Direccion complementaria
|-
| telefono || string || Numero de telefono
|-
| ext || int || Numero extension
|-
| movil || string || Numero de movil celular
|-
| pais || string || Nombre pais
|-
| departamento || string || Nombre del departamento
|-
| ciudad || string || Nombre de la ciudad
|-
| codciudad || string || Codigo unico de la ciudad
|-
| zona || int || id de la zona
|-
| email || string || cuenta de email
|-
| activo || bool || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || decimal || Cupo de credito
|-
| periodopago || int || Periodo de pago en dias para el vencimiento de facturas de venta
|-
| codigociiu || string || Codigo CIIU, Actividades economicas
|-
| descuentoventa || decimal || Porcentaje para el descuento en ventas
|-
| categoriatercero || int || Id de la categoria de tercero
|-
| formapago || int || Id de la forma pago
|-
| listaprecios || int || Id de la lista de precios
|-
| grupoventas || int || Id del grupo de retenciones para ventas
|-
| grupocompras || int || Id del grupo de retenciones para compras
|-
| vendedor || int || Numero de identificacion del vendedor
|-
| cobrador || int || Numero de identificacion del cobrador
|-
| fechacreacion || string || Fecha de creacion del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || int || Id del regimen tributario
|-
| banco || int || Id del banco
|-
| tipo cuenta || string || Tipo de cuenta bancaria (A=Cuenta de ahorro, B=Cuenta Corriente)
|-
| cuenta bancaria || string || Numero de cuenta bancaria
|-
| limite credito || decimal || Limite del credito
|-
| camposcliente || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>
 
<!-- ***************** POST ****************** -->
<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">
{
            "tipoidentidad": "CC",
            "identificacion": "123456789",
            "dv": 0,
            "tipopersona": 2,
            "primernombre": "PEDRO",
            "segundonombre": "LUIS",
            "primerapellido": "PEREZ",
            "segundoapellido": "LOPEZ",
            "nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
            "razonsocial": null,
            "escliente": true,
            "esproveedor": true,
            "esempleado": false,
            "esvendedor": false,
            "esotro": false,
            "escobrador": false,
            "cumple_dia": 0,
            "cumplea_mes": 0,
            "cumplea_ano": 0,
            "genero": "N",
            "direccion": "CRA 1 25 05",
            "direccion2": null,
            "telefono": null,
            "ext": 0,
            "movil": null,
            "pais": "COLOMBIA",
            "departamento": "VALLE",
            "ciudad": "SANTIAGO DE CALI",
            "codciudad": "76001",
            "zona": 0,
            "email": "prueba@mail.com",
            "activo": true,
            "cupocredito": 0.00,
            "periodopago": 0,
            "codigociiu": null,
            "descuentoventa": 0,
            "categoriatercero": 1,
            "formapago": 0,
            "listaprecios": 2,
            "grupoventas": 1,
            "grupocompras": 2,
            "vendedor": 0,
            "cobrador": 0,
            "fechacreacion": "2020-01-04 10:16:30",
            "regimen": 2,
            "banco": 0,
            "tipo_cuenta": null,
            "cuenta_bancaria": null,
            "limite_credito": 0.00000,
            "camposcliente": {
                "ACTIVIDADECONOMICAMUNICIPAL": "BC44",
                "Comentarios": "Cliente proveedor de software",
                "Comuna": 11,
                "FechaAniversario": "2016-06-01",
                "ClienteNacional": true,
                "Ranking": "2",
                "TieneAsesor": "N",
                "Vetado": "3",
                "TipodeEmpresa": [
                    "b",
                    "c"
                ],
                "continente": ""
            }
 
 
        }
 
</syntaxhighlight>
 
''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| direccion || String || SI || Dirección
|-
| direccion2 || String || NO || Dirección complementaria
|-
| telefono || String || NO || Número de teléfono
|-
| ext || Int || NO || Número de extensión
|-
| movil || String || SI || Número de móvil celular
|-
| pais || String || Informativo || Nombre País
|-
| departamento || String || Informativo || Nombre del departamento
|-
| ciudad || String || Informativo || Nombre de la ciudad
|-
| codciudad || String || SI || Código único de la ciudad
|-
| zona || Int || NO || ID de la zona
|-
| email || String || SI || Cuenta de email
|-
| activo || Bool || SI || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || Decimal || NO || Cupo de crédito
|-
| periodopago || Int || NO || Período de pago en días para el vencimiento de facturas de venta
|-
| codigociiu || String || NO || Código CIIU, Actividades económicas
|-
| descuentoventa || Decimal || NO || Porcentaje para el descuento en ventas
|-
| categoriatercero || Int || SI || ID de la categoría de terceros
|-
| formapago || Int || NO || ID de la forma de pago
|-
| listaprecios || Int || NO || ID de la lista de precios
|-
| grupoventas || Int || SI || ID del grupo de retenciones para ventas
|-
| grupocompras || Int || SI || ID del grupo de retenciones para compras
|-
| vendedor || Int || NO || Número de identificación del vendedor
|-
| cobrador || Int || NO || Número de identificación del cobrador
|-
| fechacreacion || String || NO || Fecha de creación del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || Int || SI || ID del régimen tributario
|-
| banco || Int || NO || ID del banco
|-
| tipo_cuenta || String || NO || Tipo cuenta bancaria. (A=Cuenta de Ahorro, B=Cuenta Corriente)
|-
| cuenta_bancaria || String || NO || Número de cuenta bancaria
|-
| limite_credito || Decimal || NO || Límite del crédito
|-
| camposcliente || Objeto || NO || Objeto con la información de campos personalizados
|}
 
 
'''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": 201,
    "errors": [],
    "message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>
 
<!-- ***************** PUT ****************** -->
<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]]
<!-- [[Category:Pages with syntax highlighting errors]] -->

Revisión del 17:38 25 may 2023

  • Pestaña 1
         Contenido de la pestaña 1.
  • Pestaña 2
         Contenido de la pestaña 2.
Obtenido de «https://www.wikiserpi.com/index.php?title=API_Articulos/Lineas&oldid=271»