Example, Inc. - Dev-Admin Portal APIs

Reviewer APIs

Click an API to expand/collapse it.

PUTAssign Reviewer to an Application

Description

Assigns a Reviewer to an application.

Request Endpoint

PUT https://<Example api server address>/reviewer/assign/{reviewerId}/{applicationId}

Parameters

Parameter	Type	Use	Description
reviewerId	String	Required	The Reviewer ID.
applicationId	String	Required	The application ID.

cURL syntax

curl --include \
     --request PUT \
'https://impk.ntg.Example.net/reviewer/assign/reviewerId/applicationId'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "b24a278b-3980-4ac5-a3d9-0df7e3a42080",
    "createdOn": 1478762054114,
    "lastModifiedOn": 1478762054114,
    "updatedBy": "",
    "deleted": false,
    "name": "ZqgTGaqqVV",
    "appPackage": "appPac",
    "bundleIdentifier": "JrWlAMAOcj",
    "casino": {
      "id": "4cae0941-b04a-468a-86ef-09ad35225890",
      "createdOn": 1478762053657,
      "lastModifiedOn": 1478762053657,
      "updatedBy": "",
      "deleted": false,
      "name": "VLKTkdcNBl",
      "videoUrl": null,
      "imageUrl": null,
      "description": null,
      "website": null,
      "icon": null,
      "banner": null,
      "deletedBy": null,
      "deletedOn": null,
      "operatorStatus": "VERIFIED",
      "email": "836cd567cb8a408a83332e45f7aa8edf@gmail.com",
      "userRole": "OPERATOR",
      "firstName": null,
      "lastName": null,
      "address": null,
      "externalId": null,
      "featuredAppId": null,
      "latestAppId": null
    },
    "casinoId": null,
    "categories": [
      {
        "id": "adbe82a0-a81f-4c84-b496-6afdd6502458",
        "createdOn": 1478762053584,
        "lastModifiedOn": 1478762053584,
        "updatedBy": "",
        "deleted": false,
        "imageUrl": "http://www.google.com/betting.png",
        "name": "yqGSTZpEqH",
        "description": "Some poker category",
        "videoUrl": "https://www.google.com/betting-video.mov",
        "iconUrl": "https://www.google.com/betting-icon.png",
        "colorCode": "#FFFFFF",
        "heroImageReference": "https://www.google.com/hero.png",
        "priority": 1,
        "deletedBy": null,
        "deletedOn": null,
        "apps": null
      }
    ],
    "categoryIds": null,
    "downloads": 0,
    "featured": false,
    "applicationVersionIds": null,
    "keywords": null,
    "latestBuild": null,
    "latestVersion": "v0.3",
    "initialVersionPublishDate": null,
    "latestVersionPublishDate": null,
    "order": null,
    "paragraph1": null,
    "paragraph2": null,
    "paragraph3": null,
    "paragraph4": null,
    "presetPriceList": null,
    "price": null,
    "publisherId": "79c69f57-445b-48ad-a46f-df3761623aa0",
    "publisher": {
      "id": "79c69f57-445b-48ad-a46f-df3761623aa0",
      "createdOn": 1478762053967,
      "lastModifiedOn": 1478762053967,
      "updatedBy": "",
      "deleted": false,
      "name": "SVQJENQbbg",
      "description": null,
      "email": "0d9d98dbb70c4edeba68fdb57aaa05a4@gmail.com",
      "website": null,
      "phone": null,
      "publisherStatus": "VERIFIED",
      "operatorId": "4cae0941-b04a-468a-86ef-09ad35225890",
      "userRole": "PUBLISHER"
    },
    "ranking": null,
    "subtitle": null,
    "updated": null,
    "status": "DRAFTED",
    "downloadLink": null,
    "compatibility": "kitkat",
    "sizeOnDisk": null,
    "permissionDetails": null,
    "additionalDetails": "This application is very popular",
    "tags": null,
    "rating": {
      "count": 0,
      "overall": 0,
      "gamePlay": 0,
      "design": 0,
      "ease": 0
    },
    "silent": null,
    "normal": {
      "min": 1,
      "max": 1
    },
    "mandatory": null,
    "downgrade": null,
    "deletedBy": null,
    "deletedOn": null,
    "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/abcd.png",
    "sliderImages": [
      {
        "id": "6cffaab6-75d8-4c5d-b6a8-4ddccbfde9a8",
        "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/slider1.jpg",
        "order": 1
      },
      {
        "id": "b4bfccb4-e39c-4e26-bdf4-97269f25b5db",
        "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": null,
    "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",
    "privacyPolicy": "www.privecypolicy.com/2345",
    "locationSupported": [
      "India",
      "UK"
    ],
    "languageSupported": [
      "English",
      "French"
    ],
    "affiliateLaunchMode": null,
    "affiliateLaunchData": null,
    "reviewer": {
      "id": "3604ee8b-b14c-40b6-a72b-015de8a1fa2f",
      "createdOn": 1478762053740,
      "lastModifiedOn": 1478762053740,
      "updatedBy": "",
      "deleted": false,
      "email": "3e1655c23bc5448cbfe1e9a5ed82fe5a@gmail.com",
      "name": "KIEyslFPQL",
      "phone": "+919916248135",
      "userRole": "REVIEWER_USER",
      "reviewerStatus": "VERIFIED",
      "emailCode": null
    }
  },
  "detail": null,
  "error": false,
  "message": "Application is assigned to Reviewer successfully"
}

Return to top

DELETEDelete Reviewers

Description

Deletes Reviewers.

Request Endpoint

DELETE https://<Example api server address>/reviewer/delete/{id}

Parameters

Parameter Type Use Description

id String Required The Reviewer ID.

cURL syntax
curl --include \
     --request DELETE \
'https://impk.ntg.Example.net/reviewer/delete/id'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "6932c8d6-82c9-4ec0-844e-029bcaceae94",
    "createdOn": 1477054320727,
    "lastModifiedOn": 1478711072081,
    "updatedBy": "",
    "deleted": true,
    "email": "a66b5aee3c1446d79a4689c9baada8f9@gmail.com",
    "name": "PajRYZEHvT",
    "phone": "+919916248135",
    "userRole": "REVIEWER_USER",
    "reviewerStatus": "VERIFIED",
    "emailCode": null
  },
  "detail": null,
  "error": false,
  "message": "Reviewer deleted successfully."
}
Return to top

Parameter	Type	Use	Description
id	String	Required	The Reviewer ID.

GETFetch a Reviewer's Detail

Description

Fetch reviewer's details irrespective to any status / deleted.

Request Endpoint

GET https://<Example api server address>/reviewer/details/{reviewerId}

Parameters

Parameter Type Use Description

reviewerId String Required The Reviewer id

cURL Syntax
curl --include \
'https://impk.ntg.Example.net/reviewer/details/reviewerId'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "c4207fd4-9f0d-488c-9b77-74c964ca4a5b",
    "createdOn": 1477312985416,
    "lastModifiedOn": 1477312985416,
    "updatedBy": "",
    "deleted": false,
    "email": "cefd8706cfb2426d88ded54271c010c1@gmail.com",
    "name": "BujxXfaKpo",
    "phone": "+919916248135",
    "userRole": "REVIEWER_USER",
    "reviewerStatus": "VERIFIED"
  },
  "detail": null,
  "error": false,
  "message": "Reviewer is fetched successfully.",
  "code": "1000"
}
Return to top

Parameter	Type	Use	Description
reviewerId	String	Required	The Reviewer id

GETFetch All Reviewers

Description

Gets all Reviewers.

Request Endpoint

GET https://<Example api server address>/reviewer/all

Parameters

None.

cURL syntax

curl --include \
'https://impk.ntg.Example.net/reviewer/all'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": [
    {
      "id": "dead8020-d23a-4644-9798-57103975d5dc",
      "createdOn": 1477043866177,
      "lastModifiedOn": 1477043866177,
      "updatedBy": "",
      "deleted": false,
      "email": "035da42cdd0b4d14b5ac1cab724a5db5@gmail.com",
      "name": "MBNMnkRxXp",
      "phone": "+919916248135",
      "userRole": "REVIEWER_USER",
      "reviewerStatus": "VERIFIED",
      "emailCode": null
    },
    {
      "id": "4f6a46dd-56c4-42d4-b13f-4de157366d08",
      "createdOn": 1477043887871,
      "lastModifiedOn": 1477043887871,
      "updatedBy": "",
      "deleted": false,
      "email": "dc9de1e173624221a01caf3e12df9e5c@gmail.com",
      "name": "FlvctFuOaV",
      "phone": "+919916248135",
      "userRole": "REVIEWER_USER",
      "reviewerStatus": "VERIFIED",
      "emailCode": null
    }
  ],
  "detail": null,
  "error": false,
  "message": "Reviewers are fetched successfully."
}

Return to top

PUTReviewer Approve or Reject Publish Application

Description

Enables a Reviewer to approve or reject a publish request from a Publisher.

Request Endpoint

PUT https://<Example api server address>/reviewer/app/release/approve/reject

Parameters

None.

cURL syntax

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"reviewerId\" : \"f36fd5a2-8613-46f4-84b5-9cbfa1f1d247\",
    \"versionId\" : \"862d8f6a-0e9b-4bf2-ade5-ebe00b59ff3e\",
    \"approvalStatus\" : \"APPROVED\",
    \"reason\" : \"I released\"
}" \
'https://impk.ntg.Example.net/reviewer/app/release/approve/reject'

PUT body attributes (JSON)

Attribute	Type	Use	Description
`reviewerId`	String	Optional	Reviewer id. If not passed, the id will be taken from the header token.
`versionId`	String	Required	The version id.
`approvalStatus`	String	Required	APPROVED / REJECTED.
`reason`	String	Optional	The reason to reject.

PUT body

Headers: Content-Type: application/json

{
  "reviewerId": "f36fd5a2-8613-46f4-84b5-9cbfa1f1d247",
  "versionId": "862d8f6a-0e9b-4bf2-ade5-ebe00b59ff3e",
  "approvalStatus": "APPROVED",
  "reason": "I released"
}

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "862d8f6a-0e9b-4bf2-ade5-ebe00b59ff3e",
    "deleted": false,
    "build": 2,
    "version": "v1.0",
    "versionDate": 1474573309405,
    "releaseDate": null,
    "downloadLink": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.mkt/3817f2a8-df2e-4ce0-845b-062c4fd4b8a4.apk",
    "rating": {
      "count": 0,
      "overall": 0,
      "gamePlay": 0,
      "design": 0,
      "ease": 0
    },
    "description": null,
    "image": null,
    "sliderImages": [
      {
        "id": "235a4379-f466-4ea6-88b5-a0334d7a2655",
        "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/869405ae-faf4-4fbb-b8be-00cbf339f5f3.jpeg",
        "order": 1
      },
      {
        "id": "4850bec2-9dec-4a25-8a1c-f24354735866",
        "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/10521287-f638-4ea4-b7f6-997f567b4ad8.jpeg",
        "order": 2
      },
      {
        "id": "c0b722ff-02cb-4288-917c-d5d865f34a51",
        "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/a0f403c1-3f57-444c-9276-c1e3f7801adb.jpeg",
        "order": 3
      },
      {
        "id": "b00325fd-b54b-4a9f-984f-fd6698fd4501",
        "image": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/b79db7e3-b766-40b5-a0aa-7332cfa8b0ad.jpeg",
        "order": 4
      }
    ],
    "banner": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/f1f449f0-3565-4d03-aaf5-796d0e5d6f86.png",
    "video": null,
    "icon": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/6456c0c5-0962-4c63-a453-a2d106d9057a.png",
    "featuredImage": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/f1f449f0-3565-4d03-aaf5-796d0e5d6f86.png",
    "versionStatus": "PUBLISHED",
    "privacyPolicy": null,
    "locationSupported": null,
    "languageSupported": null,
    "publishNow": false,
    "publishDate": ISODate("2016-09-27T00:00:00.000+0000"),
    "silent": "10",
    "optional": "8",
    "forced": "5",
    "signatureToken": null,
    "applicationId": "f072f053-45b6-40f1-8d42-99a3ceab9e2a",
    "reviewerId": "f36fd5a2-8613-46f4-84b5-9cbfa1f1d247",
    "reason": "I released"
  },
  "detail": null,
  "error": false,
  "message": "Application publish approve/reject success"
}

Return to top

POSTReviewer Send Invitation

Description

The Reviewer Send Invitation is called by a Super Admin.

It will send an activation link to the respective mail id.

On clicking the link, it will verify and redirect to setup the account UI page.

Request Endpoint

POST https://<Example api server address>/reviewer/invite

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"email\" : \"sudipta.bhaumik@gmail.com\"
}" \
'https://impk.ntg.Example.net/reviewer/invite'
POST body attributes (JSON)

Attribute Type Use Description

email String Required The reviewer email name.

POST body
Headers: Content-Type: application/json
{
  "email": "sudipta.bhaumik@gmail.com"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "f36fd5a2-8613-46f4-84b5-9cbfa1f1d247",
    "deleted": false,
    "email": "sudipta.bhaumik@gmail.com",
    "name": null,
    "phone": null,
    "userRole": "REVIEWER",
    "reviewerStatus": "INVITED",
    "emailCode": "248005"
  },
  "detail": null,
  "error": false,
  "message": "Reviewer invitation sent"
}
Return to top

Attribute	Type	Use	Description
`email`	String	Required	The reviewer email name.

POSTReviewer Send Re-invitation

Description

Request Endpoint

POST https://<Example api server address>/reviewer/reinvite

Parameters

None.

cURL Syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"email\" : \"dc9de1e173624221a01caf3e12df9e5c@gmail.com\"
}" \
'https://impk.ntg.Example.net/reviewer/reinvite'
POST body attributes (JSON)

Attribute Type Use Description

email String Required The reviewer email/name address.

POST body
Headers: Content-Type: application/json
{
  "email": "dc9de1e173624221a01caf3e12df9e5c@gmail.com"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "4f6a46dd-56c4-42d4-b13f-4de157366d08",
    "createdOn": 1477043887871,
    "lastModifiedOn": 1477043887871,
    "updatedBy": "",
    "deleted": false,
    "email": "dc9de1e173624221a01caf3e12df9e5c@gmail.com",
    "name": "FlvctFuOaV",
    "phone": "+919916248135",
    "userRole": "REVIEWER_USER",
    "reviewerStatus": "VERIFIED"
  },
  "detail": null,
  "error": false,
  "message": "Reviewer invitation sent",
  "code": "1000"
}
Return to top

Attribute	Type	Use	Description
`email`	String	Required	The reviewer email/name address.

PUTReviewer Setup Account

Description

Clicking the activation link to the respective mail id will verify and redirect to setup the account UI page.

The page will do the following setups by calling this service.

The setup will happen only one time for one Reviewer.

Request Endpoint

PUT https://<Example api server address>/reviewer/setup/account

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"reviewerId\" : \"f36fd5a2-8613-46f4-84b5-9cbfa1f1d247\",
    \"name\" : \"sudipta\",
    \"phone\" : \"+919916248135\",
    \"password\" : \"pass1\"
}" \
'https://impk.ntg.Example.net/reviewer/setup/account'
PUT body attributes (JSON)

Attribute Type Use Description

reviewerId String Required The reviewer object id.

name String Required The reviewer's name.

phone String Optional The reviewer's phone.

password String Required The reviewer's password.

PUT body
Headers: Content-Type: application/json
{
  "reviewerId": "f36fd5a2-8613-46f4-84b5-9cbfa1f1d247",
  "name": "sudipta",
  "phone": "+919916248135",
  "password": "pass1"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "f36fd5a2-8613-46f4-84b5-9cbfa1f1d247",
    "deleted": false,
    "email": "sudipta.bhaumik@gmail.com",
    "name": "sudipta",
    "phone": "+919916248135",
    "userRole": "REVIEWER",
    "reviewerStatus": "VERIFIED",
    "emailCode": null
  },
  "detail": null,
  "error": false,
  "message": "Reviewer setup account is completed successfully"
}
Return to top

Attribute	Type	Use	Description
`reviewerId`	String	Required	The reviewer object id.
`name`	String	Required	The reviewer's name.
`phone`	String	Optional	The reviewer's phone.
`password`	String	Required	The reviewer's password.

PUTReviewer Suspend

Description

Suspends a reviewer.

Request Endpoint

PUT https://<Example api server address>/reviewer/suspend/{reviewerId}

Parameters

Parameter Type Use Description

reviewerId String Required The Reviewer ID.

cURL syntax
curl --include \
     --request PUT \
'https://impk.ntg.Example.net/reviewer/suspend/reviewerId'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "69376f7d-65dd-495a-9649-964317d01de2",
    "createdOn": 1478775174507,
    "lastModifiedOn": 1478775174507,
    "updatedBy": "",
    "deleted": false,
    "email": "800a3553b4da44e4bb5201ae98fd57e8@gmail.com",
    "name": null,
    "phone": null,
    "userRole": "REVIEWER_USER",
    "reviewerStatus": "SUSPEND",
    "emailCode": null
  },
  "detail": null,
  "error": false,
  "message": "Reviewer suspend success"
}
Return to top

GETReviewer Verify Invitation

Description

Verifies the reviewer invitation was received through the mail id.

This link will be generated and sent to the mail id.

Clicking it will verify and redirect to setup the account UI.

Request Endpoint

GET https://<Example api server address>/reviewer/verify/{reviewerId}/{emailCode}

Parameters

Parameter Type Use Description

reviewerId String Required The reviewer Id.

emailCode String Required A system-generated code.

cURL syntax
curl --include \
'https://impk.ntg.Example.net/reviewer/verify/reviewerId/emailCode'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{}
Return to top

Parameter	Type	Use	Description
reviewerId	String	Required	The reviewer Id.
emailCode	String	Required	A system-generated code.

PUTReviewer Withdraw Invitation

Description

Withdraws an invitation.

Request Endpoint

PUT https://<Example api server address>/reviewer/invite/withdraw/{reviewerId}

Parameters

Parameter Type Use Description

reviewerId String Required The Reviewer ID.

cURL syntax
curl --include \
     --request PUT \
'https://impk.ntg.Example.net/reviewer/invite/withdraw/reviewerId'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "69376f7d-65dd-495a-9649-964317d01de2",
    "createdOn": 1478772433988,
    "lastModifiedOn": 1478772433988,
    "updatedBy": "",
    "deleted": false,
    "email": "800a3553b4da44e4bb5201ae98fd57e8@gmail.com",
    "name": null,
    "phone": null,
    "userRole": "REVIEWER_USER",
    "reviewerStatus": "WITHDRAWN_INVITE",
    "emailCode": null
  },
  "detail": null,
  "error": false,
  "message": "Reviewer withdraw invitation success"
}
Return to top

PUTReviewer Withdraw Suspension

Description

Withdraws a reviewer's suspension.

Request Endpoint

PUT https://<Example api server address>/reviewer/withdraw/suspend/{reviewerId}

Parameters

Parameter Type Use Description

reviewerId String Required The reviewer id.

cURL Syntax
curl --include \
     --request PUT \
'https://impk.ntg.Example.net/reviewer/withdraw/suspend/{reviewerId}'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "f26bb85d-a638-43ab-87fa-fa0b68c14072",
    "createdOn": 1477054409818,
    "lastModifiedOn": 1477054409818,
    "updatedBy": "",
    "deleted": false,
    "email": "172c9f3b3c1e417fb3a32e0493256160@gmail.com",
    "name": "PBGnvpHGEb",
    "phone": "+919916248135",
    "userRole": "REVIEWER_USER",
    "reviewerStatus": "VERIFIED"
  },
  "detail": null,
  "error": false,
  "message": "Reviewer suspension is withdrawn successfully",
  "code": "1000"
}
Return to top