Changes for page Payment API

Last modified by Thomas Warren on 2020/01/23 13:50
From empty
To version 18.1
edited by Thomas Warren
on 2020/01/22 14:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Public Payment API
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.API.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.ahz
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,108 @@
1 +
2 +
3 +{{toc depth="3"/}}
4 +
5 +(% id="HServers:" %)
6 += =
7 +
8 +Swagger API documentation: [[https:~~/~~/stage-evc.payex.com/payment-api/swagger-ui.html>>https://stage-evc.payex.com/payment-api/swagger-ui.html]]
9 +
10 +(% id="HOverview" %)
11 += Overview =
12 +
13 +This API is a gateway for receiving payments through our system. It's ment to simplify external integration between different domains such as credit cards, prepaid cards, and value codes.
14 +
15 +
16 +(% id="HFlow" %)
17 +== ==
18 +
19 +(% id="HHMAC" %)
20 +== HMAC ==
21 +
22 +{{{The API also requires authentication to be present in a request.
23 +HMAC is implemented using SHA-512 secure hash algorithm.}}}
24 +
25 +See [[test client>>https://github.com/PayEx/vas-payment-api-client]] for more information and usage.
26 +
27 +
28 +== Test clients: ==
29 +
30 +----
31 +
32 +[[ vas-public-payment-api-client>>https://github.com/PayEx/vas-payment-api-client]]
33 +
34 +===== Requirements for test client: =====
35 +
36 +* Java 11
37 +* VueJS
38 +* Maven
39 +* Postgres
40 +
41 +=== Project structure: ===
42 +
43 +----
44 +
45 +{{code}}
46 +vas-payment-api-client
47 +├─┬ backend → backend module with Spring Boot code
48 +│ ├── src
49 +│ └── pom.xml
50 +├─┬ frontend → frontend module with Vue.js code
51 +│ ├── src
52 +│ └── pom.xml
53 +└── pom.xml → Maven parent pom managing both modules
54 +{{/code}}
55 +
56 +(% id="HFlow" %)
57 +== Security: ==
58 +
59 +----
60 +
61 +The API is secured with OAuth2 and HMAC.
62 +
63 +===== =====
64 +
65 +===== Versioning: =====
66 +
67 +{{code}}
68 +mvn versions:set -DgenerateBackupPoms=false
69 +{{/code}}
70 +
71 +
72 +===== Updating maven wrapper: =====
73 +
74 +{{code}}
75 +mvn -N io.takari:maven:wrapper
76 +{{/code}}
77 +
78 +
79 +===== To check for property-linked updates: =====
80 +
81 +{{code}}
82 +mvn versions:display-property-updates
83 +{{/code}}
84 +
85 +
86 +== Build docker image~: ==
87 +
88 +----
89 +
90 +{{code}}
91 +mvn versions:set -DgenerateBackupPoms=false
92 +{{/code}}
93 +
94 +
95 +== Deploy docker image~: ==
96 +
97 +----
98 +
99 +{{code}}
100 +docker-compose up -d
101 +{{/code}}
102 +
103 +
104 +== Testing application ==
105 +
106 +----
107 +
108 +