Diferencia entre revisiones de «API Terceros/Regimen Tributario»
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 8 ediciones intermedias del mismo usuario) | |||
| Línea 19: | Línea 19: | ||
== Métodos == | == Métodos == | ||
<Tabs> | <Tabs> | ||
<!-- ***************** GET ****************** --> | <!-- ************************************************************** GET ********************************************************************** --> | ||
<Tab name = "API Consulta (GET) "> | <Tab name = "API Consulta (GET) "> | ||
'''EndPoint:''' | '''EndPoint:''' | ||
https://www.apis.serpi.com.co/api/v1/ | <nowiki>https://www.apis.serpi.com.co/api/v1/RegimenTributario</nowiki> | ||
'''EndPoint con parámetros:''' | '''EndPoint con parámetros:''' | ||
https://www.apis.serpi.com.co/api/v1/ | <nowiki>https://www.apis.serpi.com.co/api/v1/RegimenTributario?limite=50&pagina=1</nowiki> | ||
{| class="wikitable" | |||
{| class="wikitable | |+ Headers | ||
|- | |||
! Header !! Descripción | ! Header !! Descripción | ||
|- | |- | ||
| Línea 37: | Línea 37: | ||
'''Authorization:''' | '''Authorization:''' | ||
<syntaxhighlight | <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> | ||
{| 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 53: | ||
'''Response''' | '''Response''' | ||
<syntaxhighlight lang="JSON | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"success": true | "success": true | ||
"code": 200, | "code": 200, | ||
"message": " | "message": "1 registro(s) encontrados", | ||
"result": [ | "result": [ | ||
{ | |||
"id": 0, | |||
"descripcion": "Regimen Tributario Demo", | |||
"maneja_documento_soporte": true, | |||
"omitir_impuesto": true | |||
} | |||
] | ] | ||
} | } | ||
| Línea 78: | Línea 76: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{| 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 régimen tributario | ||
|- | |- | ||
| | | descripcion || string || Descripción del régimen tributario | ||
|- | |- | ||
| | | maneja_documento_soporte || bool || Si maneja documento soporte | ||
|- | |- | ||
| | | omitir_impuesto || bool || Si omite Impuesto en Factura y Devolución de Compra | ||
|} | |} | ||
</Tab> | </Tab> | ||
<!-- ***************** POST ****************** --> | <!-- ************************************************************** POST ********************************************************************** --> | ||
<Tab name = "API Creación (POST) "> | <Tab name = "API Creación (POST) "> | ||
'''EndPoint:''' | '''EndPoint:''' | ||
https://www.apis.serpi.com.co/api/v1/ | https://www.apis.serpi.com.co/api/v1/RegimenTributario | ||
{| class="wikitable" | |||
{| class="wikitable | |+ Headers | ||
|- | |||
! Header !! Descripción | ! Header !! Descripción | ||
|- | |- | ||
| Línea 113: | Línea 105: | ||
'''Authorization:''' | '''Authorization:''' | ||
<syntaxhighlight | <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"> | ||
{ | { | ||
"descripcion": "REGIMEN DE PRUEBA", | |||
"descripcion": " | "maneja_documento_soporte": true, | ||
"omitir_impuesto": true | |||
" | |||
" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{| class="wikitable | {| class="wikitable" | ||
|+ Campos del request | |||
|- | |||
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción | ! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción | ||
|- | |- | ||
| descripcion || string || 100 || Si || Descripción del régimen tributario | |||
| descripcion|| string || | |||
|- | |- | ||
| | | maneja_documento_soporte || bool || 1 || No || Si maneja documento soporte | ||
|- | |- | ||
| | | omitir_impuesto|| bool || 1 || No || Si omite Impuesto en Factura y Devolución de Compra | ||
|} | |} | ||
''' | ==== '''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''' | '''Response''' | ||
<syntaxhighlight lang="JSON | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"success": true | "success": true, | ||
"code": 201, | |||
"errors": null, | |||
"message": "registro creado exitosamente" | |||
} | } | ||
</syntaxhighlight> | |||
'''Validaciones''' | |||
<syntaxhighlight lang="JSON"> | |||
{ | { | ||
"success": false, | |||
"code": 400, | |||
"errors": [ | |||
"El campo descripcion es obligatorio" | |||
], | |||
"message": "Se presentaron errores al crear el registro" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</Tab> | </Tab> | ||
<!-- ***************** PUT ****************** --> | <!-- ************************************************************** PUT ********************************************************************** --> | ||
<Tab name = "API Modificar(PUT) "> | <Tab name = "API Modificar(PUT) "> | ||
'''EndPoint:''' | '''EndPoint:''' | ||
https://www.apis.serpi.com.co/api/v1/ | https://www.apis.serpi.com.co/api/v1/RegimenTributario | ||
{| class="wikitable" | |||
{| class="wikitable | |+ Headers | ||
|- | |||
! Header !! Descripción | ! Header !! Descripción | ||
|- | |- | ||
| Línea 196: | Línea 174: | ||
'''Authorization:''' | '''Authorization:''' | ||
<syntaxhighlight | <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, | ||
"descripcion": "REGIMEN DE PRUEBA", | |||
"descripcion": " | "maneja_documento_soporte": true, | ||
" | "omitir_impuesto": true | ||
" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{| class="wikitable | {| class="wikitable" | ||
|+ Campos del request | |||
|- | |||
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción | ! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción | ||
|- | |- | ||
| id || int || | | id || int || 11 || Si || Corresponde al identificador del régimen tributario | ||
|- | |- | ||
| | | descripcion || string || 100 || Si || Descripción del régimen tributario | ||
|- | |- | ||
| | | maneja_documento_soporte || bool || 1 || No || Si maneja documento soporte | ||
|- | |- | ||
| | | omitir_impuesto|| bool || 1 || No || Si omite Impuesto en Factura y Devolución de Compra | ||
|} | |} | ||
''' | ==== '''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''' | '''Response''' | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"success": true, | |||
"code": 200, | "code": 200, | ||
" | "errors": null, | ||
" | "message": "registro modificado exitosamente" | ||
} | } | ||
{ | |||
"success": false, | |||
"code": 204, | |||
"errors": null, | |||
"message": "No se encontraron registros con el id 1" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
''' | '''Validaciones''' | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
" | "success": false, | ||
" | "code": 400, | ||
"errors": [ | |||
" | "El campo id es obligatorio", | ||
"El campo descripcion es obligatorio" | |||
], | |||
"message": "Se presentaron errores al modificar el registro" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</Tab> | </Tab> | ||
</Tabs> | </Tabs> | ||
== Códigos de estado HTTP == | |||
{| class="wikitable left" | {| class="wikitable left" | ||
! Código !! Descripción | ! Código !! Descripción | ||
| Línea 364: | Línea 264: | ||
|} | |} | ||
== ¿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/RegimenTributario") | |||
.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/RegimenTributario"); | |||
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/RegimenTributario'); | |||
$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:34 29 may 2023
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) ">
EndPoint: https://www.apis.serpi.com.co/api/v1/RegimenTributario
EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/RegimenTributario?limite=50&pagina=1
| 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á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": "1 registro(s) encontrados",
"result": [
{
"id": 0,
"descripcion": "Regimen Tributario Demo",
"maneja_documento_soporte": true,
"omitir_impuesto": true
}
]
}
{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}| Campo | Tipo de dato | Descripción |
|---|---|---|
| id | int | Corresponde al identificador del régimen tributario |
| descripcion | string | Descripción del régimen tributario |
| maneja_documento_soporte | bool | Si maneja documento soporte |
| omitir_impuesto | bool | Si omite Impuesto en Factura y Devolución de Compra |
</Tab>
<Tab name = "API Creación (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/RegimenTributario
| 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": "REGIMEN DE PRUEBA",
"maneja_documento_soporte": true,
"omitir_impuesto": true
}
| Campo | Tipo de dato | Longitud | Requerido | Descripción |
|---|---|---|---|---|
| descripcion | string | 100 | Si | Descripción del régimen tributario |
| maneja_documento_soporte | bool | 1 | No | Si maneja documento soporte |
| omitir_impuesto | bool | 1 | No | Si omite Impuesto en Factura y Devolución de Compra |
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"
],
"message": "Se presentaron errores al crear el registro"
}</Tab>
<Tab name = "API Modificar(PUT) "> EndPoint: https://www.apis.serpi.com.co/api/v1/RegimenTributario
| 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": "REGIMEN DE PRUEBA",
"maneja_documento_soporte": true,
"omitir_impuesto": true
}
| Campo | Tipo de dato | Longitud | Requerido | Descripción |
|---|---|---|---|---|
| id | int | 11 | Si | Corresponde al identificador del régimen tributario |
| descripcion | string | 100 | Si | Descripción del régimen tributario |
| maneja_documento_soporte | bool | 1 | No | Si maneja documento soporte |
| omitir_impuesto | bool | 1 | No | Si omite Impuesto en Factura y Devolución de Compra |
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"
],
"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/RegimenTributario")
.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/RegimenTributario");
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/RegimenTributario');
$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>