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

De WikiSerpi
Ir a la navegación Ir a la búsqueda
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..."
 
 
(No se muestran 35 ediciones intermedias de 2 usuarios)
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 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:'''
'''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)


'''Tipos de peticiones:'''
'''Tipos de peticiones:'''
Línea 12: Línea 11:


'''¿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.
Línea 19: Línea 16:
== Métodos ==
== Métodos ==
<Tabs>
<Tabs>
<!-- ***************** GET ****************** -->
<!-- ************************************************************** GET ********************************************************************** -->
<Tab name = "API Consulta (GET)  ">
<Tab name = "API Consulta (GET)  ">
'''GET/users'''


'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoIdentidad
<nowiki>https://www.apis.serpi.com.co/api/v1/GrupoVentas</nowiki>


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


''' Headers '''
{| class="wikitable"
{| class="wikitable left"
|+ Headers
|-
! Header !! Descripción  
! Header !! Descripción  
|-
|-
Línea 37: Línea 34:


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


'''Parámetros'''
{| class="wikitable"
{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
|-
Línea 52: Línea 50:


'''Response'''
'''Response'''
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON">
{
{
"success": true
"success": true
Línea 59: Línea 57:
"result": [
"result": [
{
{
"id": 1,
            "id": 1,
"abreviatura": "CC",
            "descripcion": "RETENCION DEMO",
"descripcion": "CEDULA CIUDADANIA",
            "retenedor_rte_fuente": true,
"codigo": 13,
            "base_rte_fuente": 1000.00,
"abreviatura2": "",
            "retenedor_rte_ica": false,
"abreviatura3": null,
            "base_min_rte_ica": 1000.00,
"excluirImpVentas": null
            "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,
            "descripcion_cuenta_rte_fuente": "DESCRIPCION CUENTA RTE. FUENTE",
            "cuenta_rte_ica": 1234567,
            "descripcion_cuenta_rte_ica": "DESCRIPCION CUENTA RTE. ICA",
            "cuenta_rte_iva": 1234567,
            "descripcion_cuenta_rte_iva": "DESCRIPCION CUENTA RTE. IVA",
            "tipogrupo": 1,
            "aplica_iva_teorico": false,
            "base_iva_teorico": 1000.00,
            "porcentaje_iva_teorico": 1000.00,
            "cuenta_iva_teorico": 1234567,
            "descripcion_cuenta_rte_iva": "DESCRIPCION CUENTA IVA TEORICO",
            "cuenta_ret_iva_teorico": 1234567,
            "descripcion_cuenta_rte_iva": "DESCRIPCION CUENTA RTE. IVA TEORICO"
        }
]
]
}
}
Línea 78: Línea 94:
</syntaxhighlight>
</syntaxhighlight>


'''Campo de resultados'''
{| class="wikitable"
{| class="wikitable"
|+ Campos de resultados
|-
! 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 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
|-
| descripcion_cuenta_rte_fuente || string || Descripción de la cuenta Rte. Fuente
|-
| cuenta_rte_ica || int || Cuenta Rte. ICA
|-
| descripcion_cuenta_rte_ica || string || Descripción de la cuenta Rte. ICA
|-
| cuenta_rte_iva || int || Cuenta Rte. IVA
|-
| descripcion_cuenta_rte_iva || string || Descripción de la cuenta Rte. IVA
|-
| tipogrupo || int || Tipo de retención (Ventas es 0 y Compras es 1)
|-
| aplica_iva_teorico || bool || Si aplica IVA teórico
|-
|-
| abreviatura || string || Abreviatura Tipo de identidad
| base_iva_teorico || double || Base IVA teórico
|-
|-
| descripcion || string || Descripción tipo de identidad
| porcentaje_iva_teorico || double || Porcentaje IVA teórico
|-
|-
| codigo || int || Código numero del tipo de identidad
| cuenta_iva_teorico || int || Cuenta IVA teórico
|-
|-
| abreviatura2 || string || Abreviatura2 Tipo de identidad
| descripcion_cuenta_iva_teorico || string || Descripción de la cuenta IVA teórico
|-
|-
| abreviatura3 || string || Abreviatura3 Tipo de identidad
| cuenta_ret_iva_teorico || int || Cuenta Rte. IVA teórico
|-
|-
| excluirImpVentas || bool || True o False. Si el tipo de identidad es excluido del impuesto de ventas
| descripcion_cuenta_ret_iva_teorico || string || Descripción de la cuenta Rte. IVA teórico
|}
|}
</Tab>
</Tab>


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


''' Headers '''
{| class="wikitable"
{| class="wikitable left"
|+ Headers
|-
! Header !! Descripción  
! Header !! Descripción  
|-
|-
Línea 113: Línea 165:


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


'''Request'''
'''Request'''
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
     "abreviatura": "NIT",
     "descripcion": "Descripcion del tipo de retención",
     "descripcion": "NIT",
    "retenedor_rte_fuente": true,
     "codigo": 31,
    "base_rte_fuente": 1000.00000,
     "abreviatura2": " NIT2",
    "retenedor_rte_ica": true,
     "abreviatura3": "",
    "base_min_rte_ica": 2000.00000,
     "excluirImpVentas": false
    "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
}
}
</syntaxhighlight>
</syntaxhighlight>


''' Campos del request'''
 
{| class="wikitable left"
{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
| 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
|-
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
| tipogrupo || int || 1 || Si || El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
|-
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
| aplica_iva_teorico || bool || 1 || No || Si aplica IVA teórico
|-
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
| base_iva_teorico || double || (18,5) || No || Base IVA teórico
|-
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
| porcentaje_iva_teorico || double || (18,5) || No || Porcentaje IVA teórico
|-
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
| cuenta_iva_teorico || int || 20 || No || Cuenta IVA teórico
|-
| cuenta_ret_iva_teorico || int || 20 || No || Cuenta Rte. IVA teórico
|}
|}


'''Authorization:'''
==== '''AVISO IMPORTANTE:''' ====
<syntaxhighlight line="1">
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.
Usar Bearer. Ejemplo “bearer {{token}}”.
 
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>


'''Response'''
'''Response'''
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON">
{
{
"success": true
    "success": true,
"code": 200,
    "code": 201,
"message": "x registro(s) encontrados",
    "errors": null,
"result": [
    "message": "registro creado exitosamente"
{
"id": 1,
"abreviatura": "CC",
"descripcion": "CEDULA CIUDADANIA",
"codigo": 13,
"abreviatura2": "",
"abreviatura3": null,
"excluirImpVentas": null
}
]
}
}
</syntaxhighlight>


'''Validaciones'''
<syntaxhighlight lang="JSON">
{
{
"success": true
    "success": false,
"code": 201,
    "code": 400,
"message": "No se encontraron registros",
    "errors": [
"result": []
        "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"
}
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>


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


''' Headers '''
{| class="wikitable"
{| class="wikitable left"
|+ Headers
|-
! Header !! Descripción  
! Header !! Descripción  
|-
|-
Línea 196: Línea 284:


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


'''Request'''
'''Request'''
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
     "id": 1
     "id": 1,
     "abreviatura": "NIT",
    "descripcion": "Descripcion del tipo de retención",
     "descripcion": "NIT",
    "retenedor_rte_fuente": true,
     "codigo": 31,
    "base_rte_fuente": 1000.00000,
     "abreviatura2": " NIT2",
     "retenedor_rte_ica": true,
     "abreviatura3": "",
    "base_min_rte_ica": 2000.00000,
     "excluirImpVentas": false
     "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
}
}
</syntaxhighlight>
</syntaxhighlight>


''' Campos del request'''
 
{| class="wikitable left"
{| class="wikitable"
|+ Campos del request
|-
! 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
| 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
|-
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
| cuenta_rte_iva || int || 20 || No || Cuenta Rte. IVA
|-
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
| tipogrupo || int || 1 || Si || El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
|-
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
| aplica_iva_teorico || bool || 1 || No || Si aplica IVA teórico
|-
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
| base_iva_teorico || double || (18,5) || No || Base IVA teórico
|-
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
| porcentaje_iva_teorico || double || (18,5) || No || Porcentaje IVA teórico
|-
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
| cuenta_iva_teorico || int || 20 || No || Cuenta IVA teórico
|-
| cuenta_ret_iva_teorico || int || 20 || No || Cuenta Rte. IVA teórico
|}
|}


'''Authorization:'''
==== '''AVISO IMPORTANTE:''' ====
<syntaxhighlight line="1">
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.
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'''
'''Response'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="JSON">
{
{
    "success": true,
     "code": 200,
     "code": 200,
     "error": null,
     "errors": null,
     "msg": "Information found for the current month",
     "message": "registro modificado exitosamente"
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
}
</syntaxhighlight>
</Tab>


<Tab name = "Python">
{
'''Request'''
    "success": false,
<syntaxhighlight lang="java" line="1">
    "code": 204,
import requests
    "errors": null,
 
    "message": "No se encontraron registros con el id 1"
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>
</syntaxhighlight>


'''Response'''
'''Validaciones'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="JSON">
{
{
     "code": 200,
     "success": false,
     "error": null,
     "code": 400,
     "msg": "Information found for the current month",
     "errors": [
    "data": [
        "El campo id es obligatorio",
         {
        "El campo descripcion es obligatorio",
            "operation": "",
         "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
            "description": "",
        "No existe una cuenta relacionada al numero auxiliar 1"
            "items": "",
    ],
            "date": ""
    "message": "Se presentaron errores al modificar el registro"
        }
    ]
}
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>
</Tabs>
</Tabs>


''' Códigos de estado HTTP'''
== Códigos de estado HTTP ==
{| class="wikitable left"
{| class="wikitable left"
! Código !! Descripción
! Código !! Descripción
Línea 364: Línea 424:
|}
|}


== ¿Cómo consumir la API? ==
<Tabs>
<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://localhost:44305/api/v1/GrupoVentas")
  .method("GET", body)
  .addHeader("secretkey", "{{secret key}}")
  .addHeader("Authorization", "Bearer{{token}}")
  .build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>
<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/GrupoVentas");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>
<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/GrupoVentas');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'secretkey' => '{{secret key}}',
  'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>
</Tabs>


[[Category:Documentación APIs]]
[[Category:Documentación APIs]]
<!-- [[Category:Pages with syntax highlighting errors]] -->
<!-- [[Category:Pages with syntax highlighting errors]] -->

Revisión actual - 15:50 27 jun 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

<Tabs> <Tab name = "API Consulta (GET) ">

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,
            "descripcion_cuenta_rte_fuente": "DESCRIPCION CUENTA RTE. FUENTE",
            "cuenta_rte_ica": 1234567,
            "descripcion_cuenta_rte_ica": "DESCRIPCION CUENTA RTE. ICA",
            "cuenta_rte_iva": 1234567,
            "descripcion_cuenta_rte_iva": "DESCRIPCION CUENTA RTE. IVA",
            "tipogrupo": 1,
            "aplica_iva_teorico": false,
            "base_iva_teorico": 1000.00,
            "porcentaje_iva_teorico": 1000.00,
            "cuenta_iva_teorico": 1234567,
            "descripcion_cuenta_rte_iva": "DESCRIPCION CUENTA IVA TEORICO",
            "cuenta_ret_iva_teorico": 1234567,
            "descripcion_cuenta_rte_iva": "DESCRIPCION CUENTA RTE. IVA TEORICO"
        }
	]
}

{
	"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
descripcion_cuenta_rte_fuente string Descripción de la cuenta Rte. Fuente
cuenta_rte_ica int Cuenta Rte. ICA
descripcion_cuenta_rte_ica string Descripción de la cuenta Rte. ICA
cuenta_rte_iva int Cuenta Rte. IVA
descripcion_cuenta_rte_iva string Descripción de la cuenta Rte. IVA
tipogrupo int Tipo de retención (Ventas es 0 y Compras es 1)
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
descripcion_cuenta_iva_teorico string Descripción de la cuenta IVA teórico
cuenta_ret_iva_teorico int Cuenta Rte. IVA teórico
descripcion_cuenta_ret_iva_teorico string Descripción de la 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();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://localhost:44305/api/v1/GrupoVentas")
  .method("GET", body)
  .addHeader("secretkey", "{{secret key}}")
  .addHeader("Authorization", "Bearer{{token}}")
  .build();
Response response = client.newCall(request).execute();

</Tab>

<Tab name = "C#"> Request 

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/GrupoVentas");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

</Tab>

<Tab name = "PHP"> Request 

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/GrupoVentas');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'secretkey' => '{{secret key}}',
  'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

</Tab>

</Tabs>

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