Purpose
The Example Dev-Admin Portal APIs provide calls for the Example Dev-Admin Portal.
HTTPS Request and Response formats
Every Request is built according to the HTTPS Method (GET, POST, PUT, PATCH, DELETE) employed by the API, and contains:
- Description of the API.
- Request URI endpoint with parameters (if any) enclosed in curly brackets { }.
- Request cURL syntax.
- Request body attribute definitions (if any) table.
- Request body with headers.
Every Response with appropriate HTTPS Status codes (400 - Bad Request / 500 - Internal Server Error / 404 - Not Found / 200 - Success) will be in HTTPS and JSON formats and contain:
- A Response header and status code.
- A Response body in JSON format.
For example, an API using the HTTPS PUT Method would be defined as follows.
PUTChange Password Casino/Operator (expanded example)
- Description
- Changes a password.
- Request Endpoint
- PUT https://<Example api server address>/casino/change/password/{casinoId}
- Parameters
Parameter Type Use Description casinoId String Required The Casino / Operator ID. - cURL syntax
curl --include \ --request PUT \ --data-binary "{ \"oldPassword\" : \"password1\", \"newPassword\" : \"pass1\" }" \ 'https://impk.ntg.Example.net/casino/change/password/casinoId'
- PUT body attributes (JSON)
Attribute Type Use Description oldPassword
String Required The old password. newPassword
String Required The new password. - PUT body
Headers: Content-Type: application/json
{ "oldPassword": "password1", "newPassword": "pass1" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "85444112-4ab7-4239-92f5-bc320b7a44ba", "name": "Casino 1", "videoUrl": null, "imageUrl": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/image2.jpeg", "description": "desc1", "website": "http://google.com", "icon": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/image1.jpeg", "banner": null, "deletedBy": null, "deletedOn": null, "operatorStatus": "VERIFIED", "email": "sudipta.bhaumik@innoflexion.com", "userRole": "OPERATOR", "firstName": "name1", "lastName": "lst nm", "address": "address" }, "detail": null, "error": false, "message": "Password changed successfully" }