vyourtaev / s4u-test-assignment

s4u

Demo version of application

• docker run -p 8080:8000 -ti yourtaev/s4u

• The list of accounts: http://127.0.0.1:8080/api/v1/list_of_accounts

• Details of account: http://127.0.0.1:8080/api/v1/account_transactions/44882998/

• create account: curl -H "Content-Type: application/json" -X POST -H "Content-type: application-json" -H "Authorization: 5a04f4f203ab4b9382977e6ac13d68ad" -d '{"currency":"GBP","balance": "1000"}' http://localhost:8080/api/v1/accounts

• create transaction: curl -H "Content-Type: application/json" -X POST -H "Content-type: application-json" -H "Authorization: 5a04f4f203ab4b9382977e6ac13d68ad" -d '{"sourceAccount":"38817840","amount": "1000", "destAccount": "72225007"}' http://localhost:8080/api/v1/transactions

Installation

---

• Create virtualenv mkvirtualenv env -p python3.5
• turn on your virtualenvironment.
• instal dev utils into virtual environment pip install -r req.txt

Running tests

---

• ./manage.py tests

Running

---

• Migrate database ./manage.py migrate
• Load fixtures ./manage.py loaddata api/fixtures/initial_data.json
• Run application ./manage.py runserver

Additional

---

create new auth token key: ./manage.py create_auth_token token for fast access: 0c71d0f1e502425595a13123bf86f713

curl command for example: create account: curl -H "Content-Type: application/json" -X POST -H "Content-type: application-json" -H "Authorization: 5a04f4f203ab4b9382977e6ac13d68ad" -d '{"currency":"GBP","balance": "1000"}' http://localhost:8000/api/v1/accounts

create transaction: curl -H "Content-Type: application/json" -X POST -H "Content-type: application-json" -H "Authorization: 5a04f4f203ab4b9382977e6ac13d68ad" -d '{"sourceAccount":"38817840","amount": "1000", "destAccount": "72225007"}' http://localhost:8000/api/v1/transactions

URL desctiption:

---

Accounts API

---

Method: POST /api/v1/accounts

Parameters

Header parameters:

NAME	Is Mandatory?	Description
Content-Type	Yes	Data exchange takes place by means of json messaging
Authorization	Yes	Shared key for authorization

Body parameters:

NAME	Is Mandatory?	Description
currency	Yes	Type of currecny. Can be EUR, USD, GBP or CHF
balance	No	Start balance on you account can't be more then 99999999.99 and less then 0. Max length - 10 digits

Response Codes:

Code	Description
201	Account successful created
422	"currency" is required field
422	"currency" should be one of "USD", "EUR", "GBR" or "CHF"
422	negative balance on any account are not permitted.

Request example

{
	"currency":"EUR",
	"balance": "578.38",
}

Response example

{
    "data": {"accountNumber": "88205324"},
    "error": "false"
}

Transaction api

---

Method: POST /api/v1/transactions

Parameters Header parameters:

NAME	Is Mandatory?	Description
Content-Type	Yes	Data exchange takes place by means of json messaging
Authorization	Yes	Shared key for authorization

Body parameters:

NAME	Is Mandatory?	Description
sourceAccount	No	Source account number, should be if destAccount is absent. Max length - 10 digits
destAccount	No	Destination account number, should be if sourceAccount is absent. Max length - 10 digits
amount	Yes	Amount of transaction, change balance for account or accounts, can't be more then 99999999.99

Response Codes:

Code	Description
201	Transaction successful created
422	Amount can't be less then 0
422	"sourceAccount" and "destAccount" are not specified
422	"sourceAccount" and "destAccount" numbers are identical
422	"sourceAccount" or "destAccount" contain less than 8 digits
422	wrong number of sourceAccount
422	wrong number of destAccount
422	the amount is too lage for that account balance

Request example

{
	"sourceAccount": "44882998",
	"destAccount": "88205324",
	"amount": 77233
}

{
	"sourceAccount": "64183998",
	"destAccount": "",
	"amount": 77
}

Response example

{
    "data": {
        "transaction_state": "completed",
        "transactionNumber": "27117685"
    },
    "error": "false"
}

UI

---

List of accaunts availabl with help of links: /api/v1/list_of_accounts

List of transactions for the specific account availabl by clicking on the account number or with help of direct link: /api/v1/account_transactions/44882998/