API Terceros/Bancos

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

Descripción: Esta API permite sincronizar los bancos definidos en SERPI con con la plataforma que lo requiera.

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

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

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/Banco?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": 6,
            "codigo": "007",
            "descripcion": "BANCOLOMBIA",
            "codigo2": ""
        }
	]
}

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

Campo de resultados

Campo Tipo de dato Descripción
Id int Corresponde al identificador de banco
codigo string Abreviatura numerica banco
descripcion string Descripción tipo de banco
codigo int Código alterno numero del banco

</Tab>

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

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

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 

{
  "codigo": "990",
  "descripcion": "Banco Agrario de Colombia",
  "codigo2": "80"
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
Codigo string 5 SI Abreviatura numerica banco
descripcion string 100 SI Descripción tipo de banco
Codigo2 string 15 SI Código alterno numero del banco

Authorization: 

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

Response 

{
	"success": true,
    "code": 201,
    "errors": null,
    "message": "registro creado exitosamente"

}

</Tab>

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

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

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
    "codigo": "99",
    "descripcion": "DAVIVIENDA",
    "codigo2": 31,
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
Codigo string 5 SI Abreviatura numerica banco
descripcion string 100 SI Descripción tipo de banco
Codigo2 string 15 SI Código alterno numero del banco

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


<Tab name = "PHP"> Request 

$request->setRequestUrl('https://localhost:44305/api/v1/Banco');
$request->setRequestMethod('GET');
$body = new http\Message\Body;
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
  'secretkey' => 'XXX123.ABc0101.123',
  'Authorization' => '5NCdQfosUBqVeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "2 registro(s) encontrados",
    "result": [
        {
            "id": 6,
            "codigo": "007",
            "descripcion": "BANCOLOMBIA",
            "codigo2": ""
        },
        {
            "id": 7,
            "codigo": "51",
            "descripcion": "DAVIVIENDA",
            "codigo2": ""
        },
        
    ]
}

</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/Bancos&oldid=461»