Publisher APIs
POSTCreate/Add/Invite Publisher
- Description
- Create a new Publisher account.
- An email verification will be sent to verify account.
- On clicking on the provided link, the account will be created.
- Request Endpoint
- POST https://<Example api server address>/publisher/{casinoId}
- Parameters
Parameter Type Use Description casinoId String Required The Casino / Operator id. - cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"email\" : \"sudipta.bhaumik@innoflexion.com\" }" \ 'https://impk.ntg.Example.net/publisher/casinoId'
- POST body attributes (JSON)
Attribute Type Use Description String Required A unique publisher mail id. - POST body
Headers: Content-Type: application/json
{ "email": "sudipta.bhaumik@innoflexion.com" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": null, "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "INVITED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher is invited successfully." }
DELETEDelete Publisher
- Description
- Deletes a Publisher. It will modify the delete variable which is not visible in the HTTPS JSON Response.
- Request Endpoint
- DELETE https://<Example api server address>/publisher/delete/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ --request DELETE \ 'https://impk.ntg.Example.net/publisher/delete/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VARIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher is deleted successfully" }
POSTFetch Game App Status By Version
- Description
- Takes the status from the response.
- Request Endpoint
- POST https://<Example api server address>/publisher/fetch/versions/details/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The publisher id. - cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"applicationId\" : \"3bc19b2a-f4ea-40c9-8123-1a1ebdc574ce\", \"appVersion\" : \"v0.3\" }" \ 'https://impk.ntg.Example.net/publisher/fetch/versions/details/publisherId'
- POST body attributes (JSON)
Attribute Type Use Description applicationId
String Required Application id. appVersion
String Required The app version. - POST body
Headers: Content-Type: application/json
{ "applicationId": "3bc19b2a-f4ea-40c9-8123-1a1ebdc574ce", "appVersion": "v0.3" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "build": 18, "version": "v0.3", "versionDate": 1471958232438, "releaseDate": null, "downloadLink": null, "rating": { "count": 0, "overall": 0, "gamePlay": 0, "design": 0, "ease": 0 }, "description": "description about application 1", "image": null, "sliderImages": [ { "id": "fe9be54f-a922-43d2-90d3-05c4820c46e8", "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider1.jpg", "order": 1 }, { "id": "20de8e62-7111-4dae-a9a5-f3dcde1eb9c1", "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider2.jpg", "order": 0 } ], "banner": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/banner1.png", "video": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/www.youtube.com", "icon": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/icon.png", "featuredImage": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/abcd.jpeg", "versionStatus": "DRAFTED", "privacyPolicy": null, "locationSupported": [ "India", "UK" ], "languageSupported": [ "English", "French" ] }, "detail": null, "error": false, "message": "Fetch version details success." }
GETFetch Notification
- Description
- Fetches notifications for the approved versions. The list of version histories will only have the approved one.
- Request Endpoint
- GET https://<Example api server address>/publisher/fetch/version/notifications/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The publisher id. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/publisher/fetch/version/notifications/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": [ { "id": "3bc19b2a-f4ea-40c9-8123-1a1ebdc574ce", "deleted": false, "name": "fpqfYEcpWs", "appPackage": null, "bundleIdentifier": null, "casino": { "id": "ea60f58c-2fa8-41e7-801f-e107997b28c2", "deleted": false, "name": "WcnXZEpxgf", "videoUrl": null, "imageUrl": null, "description": null, "website": null, "icon": null, "banner": null, "deletedBy": null, "deletedOn": null, "operatorStatus": "VERIFIED", "email": "83ce7b4a8b114c62a57f2653f6e1e46f@gmail.com", "userRole": "OPERATOR", "firstName": null, "lastName": null, "address": null }, "casinoId": null, "categories": [ { "id": "615f28d4-ead3-483c-ac1a-d4cfac49ffb0", "deleted": false, "imageUrl": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/http://www.google.com/betting.png", "name": "ntmqkytPRn", "description": "Some poker category", "videoUrl": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/https://www.google.com/betting-video.mov", "iconUrl": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/https://www.google.com/betting-icon.png", "colorCode": "#FFFFFF", "heroImageReference": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/https://www.google.com/hero.png", "priority": 1, "deletedBy": null, "deletedOn": null } ], "categoryIds": null, "downloads": null, "featured": null, "versionHistories": [ { "build": 18, "version": "v0.3", "versionDate": 1471958232438, "releaseDate": null, "downloadLink": null, "rating": { "count": 0, "overall": 0, "gamePlay": 0, "design": 0, "ease": 0 }, "description": "description about application 1", "image": null, "sliderImages": [ { "id": "fe9be54f-a922-43d2-90d3-05c4820c46e8", "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider1.jpg", "order": 1 }, { "id": "20de8e62-7111-4dae-a9a5-f3dcde1eb9c1", "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider2.jpg", "order": 0 } ], "banner": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/banner1.png", "video": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/www.youtube.com", "icon": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/icon.png", "featuredImage": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/abcd.jpeg", "versionStatus": "APPROVED", "privacyPolicy": null, "locationSupported": [ "India", "UK" ], "languageSupported": [ "English", "French" ] } ], "keywords": null, "latestBuild": null, "latestVersion": null, "order": null, "paragraph1": null, "paragraph2": null, "paragraph3": null, "paragraph4": null, "presetPriceList": null, "price": null, "publisherId": "0171d3c4-ec64-44aa-8aa3-7809f83f2ca4", "publisher": { "id": "0171d3c4-ec64-44aa-8aa3-7809f83f2ca4", "deleted": false, "name": "IHllcTngQg", "description": null, "email": "ed9bf0ea0d9f4e4084b698611e3fdad5@gmail.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "ea60f58c-2fa8-41e7-801f-e107997b28c2", "userRole": "PUBLISHER" }, "ranking": null, "subtitle": null, "updated": null, "status": "SUBMITTED", "downloadLink": null, "compatibility": null, "sizeOnDisk": null, "permissionDetails": null, "additionalDetails": null, "tags": null, "rating": { "count": 0, "overall": 0, "gamePlay": 0, "design": 0, "ease": 0 }, "silent": null, "normal": null, "mandatory": null, "downgrade": null, "incentives": null, "deletedBy": null, "deletedOn": null } ], "detail": null, "error": false, "message": "Game app version notified" }
GETFetch Publisher Details
- Description
- Fetches publisher details by publisher id.
- Request Endpoint
- GET https://<Example api server address>/publisher/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/publisher/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher is fetched successfully." }
GETFetch Publishers by Operator
- Description
- Fetches publisher details by operator ID.
- Request Endpoint
- GET https://<Example api server address>/publisher/by/operator/{operatorId}
- Parameters
Parameter Type Use Description operatorId String Required The Operator ID. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/publisher/by/operator/operatorId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": [ { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" } ], "detail": null, "error": false, "message": "Publisher fetch is successful" }
POSTFetch Versions Details by Publisher
- Description
- Fetches versions of a game.
- Request Endpoint
- POST https://<Example api server address>/publisher/fetch/versions/details/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"applicationId\" : \"00c4e2ce-d4a6-4c79-841e-a19e741d5088\", \"appVersion\" : \"1\" }" \ 'https://impk.ntg.Example.net/publisher/fetch/versions/details/publisherId'
- POST body attributes (JSON)
Attribute Type Use Description applicationId
String Required The application id. appVersion
String Required The application version number. - POST body
Headers: Content-Type: application/json
{ "applicationId": "00c4e2ce-d4a6-4c79-841e-a19e741d5088", "appVersion": "1" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "build": 1, "version": "1", "versionDate": 1470233649421, "releaseDate": 1470233649421, "downloadLink": null, "rating": { "count": 0, "overall": 0, "gamePlay": 0, "design": 0, "ease": 0 }, "image": null, "sliderImages": null, "banner": null, "video": null, "versionStatus": null }, "detail": null, "error": false, "message": "Fetch version details success." }
PUTPublisher Change Password
- Description
- Enables a Publisher to change a password.
- Request Endpoint
- PUT https://<Example api server address>/publisher/change/password/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ --request PUT \ --header "Content-Type: application/json" \ --data-binary "{ \"oldPassword\" : \"password1\", \"newPassword\" : \"pass1\" }" \ 'https://impk.ntg.Example.net/publisher/change/password/publisherId'
- PUT body attributes (JSON)
Attribute Type Use Description oldPassword
String Required Publisher's old password. newPassword
String Required Publisher's 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": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher password modified successfully" }
GETPublisher Reset Password Request
- Description
- Sends a verification link to registered mail id.
- Clicking the link will verify the publisher and redirect to reset the password UI page.
- Request Endpoint
- GET https://<Example api server address>/publisher/reset/password/request/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/publisher/reset/password/request/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Password reset requested" }
GETPublisher Verify Reset Password Request
- Description
- Clicking the link received by email will verify the publisher and redirect to reset the password UI page.
- Request Endpoint
- GET https://<Example api server address>/publisher/reset/password/verify/{publisherId}/{emailCode}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. emailCode String Required The emailCode generated in core. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/publisher/reset/password/verify/publisherId/emailCode'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{}
POSTSetup Publisher Account
- Description
- After verification success, a publisher can set the name and password.
- Request Endpoint
- POST https://<Example api server address>/publisher/setup/account
- Parameters
- None.
- cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"name\" : \"Sudipta\", \"email\" : \"sudipta.bhaumik@innoflexion.com\", \"password\" : \"password1\" }" \ 'https://impk.ntg.Example.net/publisher/setup/account'
- POST body attributes (JSON)
Attribute Type Use Description name
String Required Publisher's name. String Required Publisher's email which is already verified through the email link. password
String Required Publisher's password. - POST body
Headers: Content-Type: application/json
{ "name": "Sudipta", "email": "sudipta.bhaumik@innoflexion.com", "password": "password1" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher setup account is completed successfully" }
POSTSubmit for Review
- Description
- Takes the status from the response.
- Request Endpoint
- POST https://<Example api server address>/publisher/submit/application/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The publisher id. - cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"versionId\" : \"284bec05-ae50-45e1-94e6-4adbf1a523fa\" }" \ 'https://impk.ntg.Example.net/publisher/submit/application/publisherId'
- POST body attributes (JSON)
Attribute Type Use Description versionId
String Required The version id. - POST body
Headers: Content-Type: application/json
{ "versionId": "284bec05-ae50-45e1-94e6-4adbf1a523fa" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "284bec05-ae50-45e1-94e6-4adbf1a523fa", "build": 18, "version": "v0.3", "versionDate": 1471958232438, "releaseDate": null, "downloadLink": null, "rating": { "count": 0, "overall": 0, "gamePlay": 0, "design": 0, "ease": 0 }, "description": "description about application 1", "image": null, "sliderImages": [ { "id": "fe9be54f-a922-43d2-90d3-05c4820c46e8", "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider1.jpg", "order": 1 }, { "id": "20de8e62-7111-4dae-a9a5-f3dcde1eb9c1", "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider2.jpg", "order": 0 } ], "banner": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/banner1.png", "video": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/www.youtube.com", "icon": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/icon.png", "featuredImage": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/abcd.jpeg", "versionStatus": "SUBMITTED", "privacyPolicy": null, "locationSupported": [ "India", "UK" ], "languageSupported": [ "English", "French" ] }, "detail": null, "error": false, "message": "Game app version is submitted successfully" }
PUTSuspend Publisher
- Description
- Suspends a Publisher.
- Request Endpoint
- PUT https://<Example api server address>/publisher/suspend/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ --request PUT \ 'https://impk.ntg.Example.net/publisher/suspend/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "SUSPENDED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher is suspended successfully" }
GETVerify Publisher
- Description
- Creates a new Publisher account.
- Email verification mail will be sent to verify account.
- Clicking on the provided link, the account will be created, verified, and will redirect to setup the account UI.
- Request Endpoint
- GET https://<Example api server address>/publisher/verify/{publisherId}/{emailCode}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. emailCode String Required The publisherId email code generated in core. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/publisher/verify/publisherId/emailCode'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{}
GETWithdraw Publisher Invitation
- Description
- Withdraw a publisher invitation until the account is verified.
- Request Endpoint
- GET https://<Example api server address>/casino/withdraw/publisher/invite/{operatorId}/{publisherId}
- Parameters
Parameter Type Use Description operatorId String Required The Operator ID. publisherId String Required The Publisher ID. - cURL syntax
curl --include \ 'https://impk.ntg.Example.net/casino/withdraw/publisher/invite/operatorId/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "1e65d7a8-63a9-4b53-b7bf-e27c6f5cc380", "name": null, "description": null, "email": "sudipta.bhaumik1@innoflexion.com", "website": null, "phone": null, "publisherStatus": "INVITED_WITHDRAWN", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher invitation is withdrawn" }
PUTWithdraw Suspension from Publisher
- Description
- Withdraws a suspension from a Publisher.
- Request Endpoint
- PUT https://<Example api server address>/publisher/withdraw/suspend/{publisherId}
- Parameters
Parameter Type Use Description publisherId String Required The Publisher ID. - cURL syntax
curl --include \ --request PUT \ 'https://impk.ntg.Example.net/publisher/withdraw/suspend/publisherId'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "8749d3fd-ad9a-4861-bf7e-4e8204f00ad2", "name": "Sudipta", "description": null, "email": "sudipta.bhaumik@innoflexion.com", "website": null, "phone": null, "publisherStatus": "VERIFIED", "operatorId": "85444112-4ab7-4239-92f5-bc320b7a44ba", "userRole": "PUBLISHER" }, "detail": null, "error": false, "message": "Publisher suspension is withdrawn successfully" }