Add getting started

This commit is contained in:
Shihaam Abdul Rahman 2024-10-22 01:22:45 +05:00
parent 0b3076db38
commit b4190d3f38
Signed by: shihaam
GPG Key ID: 6DA2E87EBC227636
2 changed files with 30 additions and 1 deletions

View File

@ -1,7 +1,36 @@
### Maldives Islamic Bank Payment Verification API ### Maldives Islamic Bank Payment Verification API
Here are example curl commands to test different scenarios: This api will allow you to fetch customers payment and your MIB account history, it will match with transaction time, account owner name and amount. \
but slight issue is that, MIB to MIB transaction sometimes have MIBs made-up name for the account owner name, This is challenging, so work around that, I added option to send customers account number to fetch the made-up name and match with it. \
(BML) Farava transations works perfectly with just the name!
## How to deploy/get started (with docker/podman)
1. Login to MIB web (https://faisanet.mib.com.mv/)[https://faisanet.mib.com.mv/] and get the cookie:
![get_cookie_env.png](get_cookie_env.png)
copy this and paste it in .env
```
QL_0=
IBSID=
```
2. Create `compose.yml` with the follwing contents:
```yaml
services:
keepalive:
env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/keepalive
api:
env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/api
ports:
- 5000:5000
```
3. Run `docker compose up -d` and that is all.
## Here are example curl commands to test different scenarios:
1. With both benefName and accountNo: 1. With both benefName and accountNo:

BIN
get_cookie_env.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 240 KiB