General information about the project DontSpy can be found here.
This section describes how to use this server part of the DontSpy client-server project. In order to use DontSpy as an overall project, please deploy also the DontSpyClient.
Clone the repository, transfer all the files onto a HTTP Web Server, secure the data transfer between client and server with a SSL certificate, secure the directory of the files with a HTTP Basic Authentification and adjust the configuration. Furthermore, create a new MySQL database and import the SQL scheme. You are ready to start.
The API is based on the REST paradigm and provides following RESTful endpoints:
Endpoint Scheme: /user/{username}
HTTP Method: GET
Parameter: None
JSON Request: None
JSON Response:
id : String
username : String
Endpoint Scheme: /message/{receivingChannel}
HTTP Method: GET
Parameter:
limit : limits the number messages returned from the database
offset : controls the pagination
JSON Request: None
JSON Response:
id : String
messageHeader : String
receivingChannel : String
timestamp : int
message : String
processingCounter : int
Endpoint Scheme: /message/processed/{id}
HTTP Method: GET
Parameter: None
JSON Request: None
JSON Response: None
Endpoint Scheme: /message/{id}
HTTP Method: DELETE
Parameter: None
JSON Request: None
JSON Response: None
Endpoint Scheme: /message/new
HTTP Method: POST
Parameter: None
JSON Request:
id : String
messageHeader : String
receivingChannel : String
timestamp : int
message : String
processingCounter : int
JSON Response: None
Endpoint Scheme: /user/new
HTTP Method: POST
Parameter: None
JSON Request:
id : String
username : String
JSON Response: None
Regulation on the access control of the API can be found here. Display configuration concerning errors can be found here. Furthermore, the settings of the Logging (Monolog Logger) can be found here. Database setting can be found here.
More information about the third-party dependencies can be found at Section 3.1 in the documentation of DontSpy (German Language).
- Mai Saito
- Lukas Ruf
- Tobias Straub
- Helmut Ruf
The License can be found here.