pablomarambio / apibanca-client

Cliente de API-Banca

Cliente Ruby de API-Banca

Apibanca::Client es el cliente de Ruby para API-Banca, el wrapper REST sobre los sitios web de los bancos de Chile.

API-Banca

API-Banca es un wrapper de servicios web REST que simplifica el acceso automatizado a los sitios web de los bancos chilenos. Soporta operaciones como la descarga de cartola y transferencias recibidas. Los bancos soportados por ahora son: BICE (banca personas) y SCOTIA (banca empresas). Obtén una llave para pruebas ingresando a http://api-banca.herokuapp.com

Instalación

Agrega esta línea a tu Gemfile

gem 'apibanca-client'

Y luego ejecuta:

$ bundle

O bien instálala tú mismo:

$ gem install apibanca-client

Uso

Instanciar el cliente

Para realizar cualquier operación desde la gema, hay que autentificarse con la API-Key obtenida en http://api-banca.herokuapp.com.

# Obtenida desde http://api-banca.herokuapp.com
API_KEY = "b3e0f65c-dea6-4003-d9d0-9a8745d9988"
client = Apibanca::Client.new(API_KEY)

Crear un banco

Los bancos pueden ser creados a través de la interfaz web o desde esta gema. Para crear un banco desde la gema, hay que proveer todos los parámetros solicitados por la clase Apibanca::Bank::BankCreationParams.

params = Apibanca::Bank::BankCreationParams.new(name: "BICE", user: "...", pass: "...", account: "...")
# => #<Apibanca::Bank::BankCreationParams account="..." name="BICE" pass="..." user="...">

banco = Apibanca::Bank.create(client, params)
# -> POST http://api-banca.herokuapp.com/api/2013-11-4/banks/ [{:bank=>{"name"=>"BICE", "user"=>"...", "pass"=>"...", "account"=>"..."}} params]
# => (Banco 3304) BICE / <usuario> / <cuenta>

banco.id
# => 3304

Estatus del banco

Indica si los parámetros de acceso a la cuenta son correctos. Nota: asegúrate de que lo sean; de otra forma el banco puede bloquear el acceso a la cuenta.

# banco = Apibanca::Bank.create(...)
banco.status # sólo se puede utilizar cuando cambie a 'ready'. Este cambio de estado toma 5 minutos aproximadamente.
# => idle

banco.refresh! # recarga el proxy desde el servidor
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/3304
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/routines/23444
# => (Banco 3304) BICE / <usuario> / <cuenta>
banco.status
# => working

banco.refresh! # unos minutos más tarde...
# ...
banco.status
# => ready

Rutinas

Permiten agendar una tarea periódica en un banco. Por ejemplo, leer la cartola.

# Todos los bancos incluyen una rutina inicial que se ejecuta cuando el banco es creado.
banco.routines
# => [(Rutina 23444) Setup inicial

# Añadiremos una rutina para leer la cartola y crear depósitos
banco.add_routine Apibanca::Bank::RoutineCreationParams.new(nombre: "LectorDepósitos", target: "cartola", what_to_do: "acumular")
# => (Rutina 23449) LectorDepósitos acumular:cartola tasks=0

# Para que la rutina trabaje, hay que indicar la frecuencia
routine = bank.routines.last
# => (Rutina 23449) LectorDepósitos acumular:cartola tasks=0

routine.schedule Apibanca::Routine::ScheduleParams.new( unit: "minutes", interval: "60" )
# -> PATCH http://api-banca.herokuapp.com/api/2013-11-4/routines/23449/schedule [params]
# => (Rutina 23449) LectorDepósitos acumular:cartola tasks=3

Descarga de depósitos

A medida que las rutinas de lectura de depósitos procesen la cartola y las transacciones, se puede invocar una función para descargar los depósitos leídos

# obtención de depósitos leídos. El objeto retornado es una 
# página que contiene máximo 20 depósitos
deposits = banco.search_deposits
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/14/deposits
# => 20/18500 depósitos [página 1/925]

deposits.length 
# => 18500

deposits.page
# => 1

deposits.pages
# => 925

deposits.first
# => (Deposit 209070) 03/01/2014 / cheque / 79695

# El batch trae un máximo de 20 depósitos
contador = 1
deposits.each do |d|
	contador = contador + 1
end
contador
# => 20

deposits.next_page
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/14/deposits?page=2
# => 20/18500 depósitos [página 2/925]

deposits.first
# => (Deposit 209070) 02/01/2014 / transferencia / 103445

También podemos buscar depósitos por 3 criterios: psd_origin_user_rut o RUT del emisor (sólo para transferencias), psd_origin_bank o nombre del banco de origen, y psd_type o tipo de depósito

# Bancos que se pueden usar como criterio de búsqueda. Para los tipos de depósito, usar Apibanca::Deposit::TYPES 
Apibanca::Bank::TYPES
# => ["BANCO SCOTIABANK", "BANCO SECURITY", "BANCO SANTANDER", "BANCO ESTADO", "BANCO CORPBANCA", "BANCO DE CHILE", "BANCO RABOBANK", "BANCO BBVA", "BANCO UNKNOWN", "BANCO BICE", "BANCO ITAU", "BANCO BCI", "BANCO BANCO INTERNA", "BANCO FALABELLA"]

# Busquemos todas las transferencias provenientes del BCI
deposits = bank.search_deposits psd_origin_bank: "BANCO BCI", psd_type: "transferencia"
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/14/deposits?psd_origin_bank=BANCO+BCI&psd_type=transferencia
# => 20/140 depósitos [página 1/7]

deposits.first
# => (Deposit 4599) 27/01/2014 / transferencia / 98060

# Los resultados de las búsquedas también vienen paginados
deposits.next_page
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/14/deposits?psd_origin_bank=BANCO+BCI&psd_type=transferencia&page=2 
# => 2

Otras funciones

Listado de bancos creados

Es posible cargar un arreglo con los bancos cargados en la cuenta

banks = Apibanca::Bank.index(client)
# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/ 
# => [(Banco 3304) BICE / <usuario> / <cuenta>, (Banco 3323) SCOTIA / <usuario> / <cuenta>]
banks.first.id
# => 3304

apibanca-client's Issues

Es posible descargar Mini Cartola de una Cuenta Corriente de BCI Empresas

Hola, me gustaría saber si pudiera con esta librería obtener los movimientos de la última cartola de una cuenta corriente de BCI Empresas?

¡Gracias!