rebasing
This commit is contained in:
142
public/Fastcheck_API (1).txt
Normal file
142
public/Fastcheck_API (1).txt
Normal file
@@ -0,0 +1,142 @@
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
Protocol: https
|
||||
Root Path: api.Fastcheck.store
|
||||
Type GET
|
||||
Path /ping
|
||||
Request Parameters:
|
||||
{
|
||||
|
||||
|
||||
}
|
||||
Response (OK):
|
||||
{
|
||||
"message": "pong",
|
||||
}
|
||||
________________
|
||||
|
||||
|
||||
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
|
||||
Type GET
|
||||
Path /websession
|
||||
Request Parameters:
|
||||
{
|
||||
|
||||
|
||||
}
|
||||
Response (OK):
|
||||
{
|
||||
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”
|
||||
"userId" : "",
|
||||
"expires" : "sessionId",
|
||||
"userSessionId": "",
|
||||
"Status": false
|
||||
}
|
||||
________________
|
||||
|
||||
|
||||
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
|
||||
Type GET
|
||||
Path /websession/:webSessionID
|
||||
Request Parameters:
|
||||
{
|
||||
|
||||
|
||||
}
|
||||
Response (OK):
|
||||
{
|
||||
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”,
|
||||
"userId" : "kHaAe9roaC2uq63AKGE/8+Ti/t/iFro68QhEZ1dRGLo",
|
||||
"expires" : "sessionId",
|
||||
"userSessionId": "8A94EFEFD003426A9B456C48CAC99BE6",
|
||||
"Status": true
|
||||
}
|
||||
________________
|
||||
Delete websession status
|
||||
Delete the session to log out from the system.
|
||||
Protocol: https
|
||||
Root Path: api.Fastcheck.store
|
||||
Type DELETE
|
||||
Path /websession/:webSessionID
|
||||
Request Parameters:
|
||||
{
|
||||
"sessionId": “1AF3781BF6B94604B771AEA1D44FA63A”
|
||||
}
|
||||
Response (OK):
|
||||
{
|
||||
}
|
||||
________________
|
||||
|
||||
|
||||
Check Fastcheck status
|
||||
Check if fastcheck exists and get the amount assigned to check.
|
||||
Protocol: https
|
||||
Root Path: api.Fastcheck.store
|
||||
Type GET
|
||||
Path /fastcheck
|
||||
|
||||
|
||||
Request Parameters:
|
||||
{
|
||||
"fastcheck": “1234-5678-0001”,
|
||||
}
|
||||
Response (OK):
|
||||
{
|
||||
"fastcheck": "1234-5678-0001",
|
||||
"expiration": 2021-07-07T09:08:18Z ,
|
||||
"Status": true
|
||||
}
|
||||
________________
|
||||
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
|
||||
Type POST
|
||||
Path /fastcheck
|
||||
HEADER: Authorization - {"sessionID": "1AF3781BF6B94604B771AEA1D44FA63A"}
|
||||
Request Parameters:
|
||||
{
|
||||
"amount": 158000,
|
||||
"currency": "RUB"
|
||||
}
|
||||
Response (OK):
|
||||
{
|
||||
"fastcheck": "1234-5678-0001",
|
||||
"expiration": 2021-07-07T09:08:18Z ,
|
||||
"code": "5864",
|
||||
"Status": true
|
||||
}
|
||||
________________
|
||||
Accept Fastcheck
|
||||
Accept fastcheck to the user balance.
|
||||
Protocol: https
|
||||
Root Path: api.Fastcheck.store
|
||||
Type POST
|
||||
Path /fastcheck
|
||||
HEADER: Authorization - {"sessionID": "1AF3781BF6B94604B771AEA1D44FA63A"}
|
||||
Request Parameters:
|
||||
{
|
||||
"fastcheck": "1234-5678-0001",
|
||||
"code": "5864"
|
||||
}
|
||||
Response (404-ERROR):
|
||||
{
|
||||
"message": "not authorized"
|
||||
}
|
||||
Response (200-OK):
|
||||
{
|
||||
"message": "ok"
|
||||
}
|
||||
Reference in New Issue
Block a user