API Terceros/Cobradores

De WikiSerpi
Ir a la navegación Ir a la búsqueda

Descripción: Esta API permite la obtener el listado de Cobradores registrados en SERPI hacia la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas, el API de cargue y modificación de datos corresponde al mismo API de Terceros.

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?

  • 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) "> GET/users

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

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/TipoIdentidad?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,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador del tipo de identidad
abreviatura string Abreviatura Tipo de identidad
descripcion string Descripción tipo de identidad
codigo int Código numero del tipo de identidad
abreviatura2 string Abreviatura2 Tipo de identidad
abreviatura3 string Abreviatura3 Tipo de identidad
excluirImpVentas bool True o False. Si el tipo de identidad es excluido del impuesto de ventas

</Tab>

<Tab name = "API Creación (POST) "> POST /users

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

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 

{
    "abreviatura": "NIT",
    "descripcion": "NIT",
    "codigo": 31,
    "abreviatura2": " NIT2",
    "abreviatura3": "",
    "excluirImpVentas": false
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
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: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response 

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
			"id": 1,
			"abreviatura": "CC",
			"descripcion": "CEDULA CIUDADANIA",
			"codigo": 13,
			"abreviatura2": "",
			"abreviatura3": null,
			"excluirImpVentas": null
		}
	]
}

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

</Tab>

<Tab name = "API Modificar(PUT) "> PUT/users

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

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
    "abreviatura": "NIT",
    "descripcion": "NIT",
    "codigo": 31,
    "abreviatura2": " NIT2",
    "abreviatura3": "",
    "excluirImpVentas": false
}

Campos del request

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: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response 

{
"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"
}

</Tab> </Tabs>

¿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>

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
Obtenido de «https://www.wikiserpi.com/index.php?title=API_Terceros/Cobradores&oldid=304»