Overview
This article provides an overview of how to create a schedule job to run the stored procedure for Player Elite.
BackOffice Job
-
Within BackOffice you will observe a new ClassName as shown below Rest API this is found within the DLL Name JobRest_Api.dll
Technology
-
The Public REST API allows 3rd party developers to connect to a users Bepoz database through an HTTP endpoint utilizing RESTful infrastructure
-
Responses will be returned in JSON format
Security
-
A secret key must be provided in each request within a header called "secret". This is provided usually by a local Bepoz representative
REST HTTP Verbs
HTTP Verb |
Operation |
|
GET |
Retrieve |
|
POST |
Add |
|
PUT |
Update |
|
DELETE |
Delete |
Definitions
Key |
Description |
|
M |
Mandatory |
|
O |
Optional |
|
* |
An option is mandatory |
Request & Response Format
-
The REST API will accept well-formed JSON requests (where required). The corresponding response will be sent in the same format
API Endpoint
-
http://{mydomain}:{port}/api/{endpoint}
Sample Request & Response
|
{ "data": "2016-06-09T16:57:05.729166+10:00" } |
Tools
-
The REST API has Swagger UI integrated. Swagger UI allows anyone to visualize and interact with the API’s resources without having any of the implementation logic in place
-
Swagger UI can be accessed once the REST API job is running
-
The URL is: http://X.X.X.X:YYY/bepoz/ui/index#!/ where X.X.X.X is the IP Address and YYY is the Port Number where the Rest API job is hosted
URL for SWAGGER UI for Testing RestAPI
http://127.0.0.1:157/bepoz/ui/index#!/
