Skip to content

Commit

Permalink
add readme and dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
rick20 committed Jul 16, 2016
1 parent 74a7e7a commit b645fef
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 2 deletions.
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
],
"require": {
"php": ">=5.4.0",
"guzzlehttp/guzzle": "~5.0|~6.0"
"guzzlehttp/guzzle": "~5.0|~6.0",
"symfony/dom-crawler": "3.1.*"
},
"autoload": {
"psr-4": {
Expand Down
44 changes: 43 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
# IBanking Package for Laravel 5

This package allows you to automatically login to your ibanking and retrieve balance and transactions. Currently only for KlikBCA.
This package allows you to crawl and parse your bank balance and statement. Currently only available for Bank BCA and Bank Mandiri.
Inspired by the original [BCA Parser](www.randomlog.org/article/bca-parser-lagi/)

## Installation

To get started with IBanking, run this command or add the package to your `composer.json`
composer require rick20/ibanking

## Configuration

After installing the IBanking package, register the `Rick20\IBanking\IBankingServiceProvider` in your `config/app.php` file.
Also, add the `IBanking` facade to the `aliases` array in your `app` configuration file:
```php
'IBanking' => Rick20\IBanking\Facades\IBanking::class,
```

Finally add these lines to your `config/services.php` file:
```php
'bca' => [
'username' => 'your-klikbca-username',
'password' => 'your-klikbca-password'
],
'mandiri' => [
'username' => 'your-mandiri-username',
'password' => 'your-mandiri-password'
]
```

## How To Use

After all sets, use the IBanking as follows:
```php
$ibank = IBanking::driver('bca');
$ibank->login(); // Must be called before anything else
$balance = $ibank->getBalance();
$statement = $ibank->getStatement();
$ibank->logout(); // Must be called after you are done.
```
Please be noted that if you forgot to call the `logout()` method, you will not be able to login to your account for a certain minutes.

## Attention!

While this package might useful for you to do automatic check on your balance statement, I don't responsible for any fraud that might come later. So please make any necessary effort to keep it safe. Changing your password regularly might help to keep it more secure.

0 comments on commit b645fef

Please sign in to comment.