This API allows you to create, remove, list inner virtual cards using dummy web service API's with microservice architecture. In version 1.0 we just have a single php project based on symfony framework.
The main point of this project is creating a virtual card via a vendor (provider) with an REST API. Every virtual card is relating to a bucket.
We can think bucket like a bank account. We store our money into buckets. The properties of a single bucket are;
| Column | Description |
|---|---|
| startDate | The first day that we can start to use this bucket's balance |
| endDate | The last day that we can start to use this bucket's balance |
| balance | Available balance of this bucket |
| currency | The currency of the bucket. Default is: USD |
| vendor | The vendor that this bucket related to |
Vendors are our providers. We can think them like banks. When user wants to create a virtual card we're sending a request to vendor. If the vendor accepts the creation of the virtual card then we create the virtual card.
| Column | Description |
|---|---|
| bucketLimit | Vendor's buckets are creating with fixed balance. This field stores the fixed balances |
| bucketDateDelta | Vendor's buckets are creating with fixed date delta. Date delta means the day count between start and end date. |
Exceptions
When a virtual card creation requested, and the vendor (that we sent a create request) rejects or returns exception, we try to create this virtual card with another available vendor. Example:
| Vendor's Name | Returned status |
|---|---|
| Lion | 503 (Service unavailable) |
| Bear | 200 (Success) |
First we sent a request to first vendor (Lion) it returned 503 and we assume that it couldn't create the virtual card. After then we sent another request to our second vendor Bear (this is fallback) and it returns 200 then we end the flow. If the second vendor returns reject response, we were going to send another request to our third vendor.
Virtual card is the main item of this project. We're trying to create a single virtual card using buckets and vendors. The basic flow to create a virtual card:
When an user request to create virtual card, the requested balance will substract from chosed bucket. (Read below to know how we're choosing the buckets).
Bucket choosing
When user requests to create virtual card, we try to find single bucket to create this virtual card. Conditions are;
- Start date must before then virtual card's
- Expire date must after then virtual card's end date
- The bucket that has biggest balance will choose
This project is using payment providers to create cards. You can inspect below providers to understand the flow better.
- Vendor Lion on Java
- Vendor Bear on NodeJs
- Vendor Rhino on GoLang
Clone this project into your computer, make sure your docker daemon is running then run;
docker-compose up
after then connect to the php container;
docker container exec -it vc_php /bin/bash
and run the following command;
composer install &&
bin/console doctrine:migrations:migrate --env=dev --no-interaction &&
bin/console doctrine:fixtures:load --env=dev --no-interaction
then the server will start on your 8080 port at localhost.
- Symfony
- MongoDB
- Redis
- Nginx
You can use adminer to access MongoDB and mysql. Adminer will be available at 8180 port on your local host.
You can access API's documentation at /doc path. We used nelmio-api-doc bundle to create documentation. It means you can test every method on project using this documentation.
Also, I added postman collection for current API. You can found them in postman folder.
I added some comments on code, but it's not enough for understanding the whole architecture. I'll add more comments, and I'll prepare a full documentation.
This project completely open source . You can fork and modify everything, and you can use this project everywhere you want. I'm transferring my experiences into this project to contribute for open source family, and I'm trying to impress the beginners with unique ways.