sdarbinyan/FastCheck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api

Browse Source
This commit is contained in:
sdarbinyan
2026-05-14 14:19:29 +04:00
parent 3a2e1bf65d
commit 1e4f0b6964
5 changed files with 25 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
public/Fastcheck_API (1).txt
View File

@@ -1,4 +1,4 @@
eFastcheck.store
eFastcheck.store
General Information
Information exchange with the Fastcheck server is realized via RESTful API. All requests to the server must be executed via HTTPS using GET||POST||PUT||DELETE requests to the given ROOT address. Body of requests must be in JSON format. All not public requests must be signed by the client and the public key must be sent to the server for client identification and sign checking.
@@ -6,9 +6,9 @@ Information exchange with the Fastcheck server is realized via RESTful API. All
Check if server is available
Client needs to periodically check if the server is available by sending “ping” to the client. On error corresponding message must be shown.
Client needs to periodically check if the server is available by sending “ping” to the client. On error corresponding message must be shown.
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type GET
Path /ping
Request Parameters:
@@ -26,7 +26,7 @@ ________________
Create new websession
Creates a new websession for qr generation. By timeout a new websession must be requested, after the user shows some activity (click on qr).
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type GET
Path /websession
Request Parameters:
@@ -36,7 +36,7 @@ Request Parameters:
}
Response (OK):
{
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”
"userId" : "",
"expires" : "sessionId",
"userSessionId": "",
@@ -48,7 +48,7 @@ ________________
Check websession status
Check if the user is already logged in. a new websession for qr generation. By timeout a new websession must be requested, after the user shows some activity (click on qr).
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type GET
Path /websession/:webSessionID
Request Parameters:
@@ -58,7 +58,7 @@ Request Parameters:
}
Response (OK):
{
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”,
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”,
"userId" : "kHaAe9roaC2uq63AKGE/8+Ti/t/iFro68QhEZ1dRGLo",
"expires" : "sessionId",
"userSessionId": "8A94EFEFD003426A9B456C48CAC99BE6",
@@ -68,12 +68,12 @@ ________________
Delete websession status
Delete the session to log out from the system.
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type DELETE
Path /websession/:webSessionID
Request Parameters:
{
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”
}
Response (OK):
{
@@ -84,14 +84,14 @@ ________________
Check Fastcheck status
Check if fastcheck exists and get the amount assigned to check.
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type GET
Path /fastcheck
Request Parameters:
{
"fastcheck": “1234-5678-0001”,
"fastcheck": “1234-5678-0001”,
}
Response (OK):
{
@@ -103,7 +103,7 @@ ________________
New Fastcheck
Create a fastcheck for a given amount. The Users must have a sufficient amount on the balance.
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type POST
Path /fastcheck
HEADER: Authorization - {"sessionID": "1AF3781BF6B94604B771AEA1D44FA63A"}
@@ -123,7 +123,7 @@ ________________
Accept Fastcheck
Accept fastcheck to the user balance.
Protocol: https
Root Path: api.Fastcheck.store
Root Path: fastcheck.store/api
Type POST
Path /fastcheck
HEADER: Authorization - {"sessionID": "1AF3781BF6B94604B771AEA1D44FA63A"}