Commit 40bf17aa authored by Miguel Mateo Montero's avatar Miguel Mateo Montero
Browse files

adding readme

parent da349280
......@@ -31,6 +31,13 @@ log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
```
## Compile and deploy
- go to the directory created when you clone this project, the one with the pom.xml file.
- compile: ```mvn clean install```
- deploy: you can copy the war file ```./target/customer_service.war``` to the directory **webapps** of the TOMCAT server or deploy using its admin web page.
## REST API
The API provides the basic functions to:
- Create customer
......@@ -39,27 +46,27 @@ The API provides the basic functions to:
- Perform the payment of the contract
-
### Create customer
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/create_customer_method.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/create_customer_method.png)
### Withdrawal
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/withdrawal_method.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/withdrawal_method.png)
### Purchase
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/purchase_method.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/purchase_method.png)
### Payment
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/payment_method.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/payment_method.png)
## Basic flow examples
Here you can find the three basic flows of the four main operations of the pilot.
### Create user
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/createCustomer.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/createCustomer.png)
### Withdrawal
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/withdrawal.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/withdrawal.png)
### Purchase and Payment
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/blob/master/img/purchase.png)
![](https://scm.atosresearch.eu/fentec_digcur_uc_pub/customer_service_pub/raw/master/img/purchase.png)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment