Example Client APIs - Global Search APIs

Global Search APIs

Click an API to expand/collapse it.

GETBy Keyword

Description

Allows a client to search based on keyword and returns an array of game apps, casinos, and categories with the present implementation.

Request Endpoint

GET https://<Example api server address>/search/{keyword}/{userId}

Parameters

Parameter	Type	Use	Description
keyword	String	Required	Keyword on which the search is based.
userId	String	Required	Id of the user to track search history.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/search/keyword/userId'

Response body

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

{
  "data": {
    "applications": [
      {
        "id": "ad614349-a8c5-44dd-ac90-9ff8d151ada6",
        "updatedBy": "",
        "name": "Green Land",
        "appPackage": "Trees",
        "banner": "Deep Green Land",
        "bundleIdentifier": "ojnhrdvh2564369",
        "casino": {
          "id": "7a8d9f34-64d3-4641-9d66-63ad85768dd2",
          "updatedBy": "",
          "imageUrl": "http://www.google.com",
          "name": "SRS",
          "videoUrl": "http://www.facebook.com"
        },
        "casinoId": null,
        "categories": null,
        "categoryIds": null,
        "description": "Large Leaves and Flowers.",
        "downloads": 1258152,
        "featured": null,
        "versionHistories": null,
        "image": "https://s3-us-west-2.amazonaws.com/Example-qa/application_images/icons/%2F4b1f7e5a-772c-4621-b06e-6f9e0438b43e.png",
        "keywords": null,
        "latestBuild": 16847,
        "latestVersion": "357",
        "order": null,
        "paragraph1": "Land 1.",
        "paragraph2": "Land 2.",
        "paragraph3": "Land 3.",
        "paragraph4": "Land 4.",
        "presetPriceList": null,
        "price": 5,
        "publisher": "DeepPIWood Blue.",
        "ranking": 15,
        "rating": null,
        "sliderImages": [
          "https://s3-us-west-2.amazonaws.com/Example-qa/application_images/slider/%2F672f1251-508b-49f2-ba4e-a3fa4d2e650c.png"
        ],
        "subtitle": "Land of The Greens.",
        "updated": null,
        "video": "https://s3-us-west-2.amazonaws.com/Example-qa/application_videos/something.mp4",
        "status": "SUBMITTED",
        "downloadLink": "https://s3-us-west-2.amazonaws.com/Example-qa/application_apk/%2F3b7a54f8-d6f8-444c-9af9-aa682e50b69d.apk",
        "compatibility": null,
        "sizeOnDisk": null,
        "permissionDetails": null,
        "locationSupported": null,
        "languageSupported": null,
        "additionalDetails": null,
        "tags": [
          "live",
          "rebuilt",
          "mobile",
          "live",
          "popular",
          "starter",
          "top"
        ],
        "promotionalBonus": null
      },
      {
        "id": "86d05a78-6916-4211-9d0a-766e8f3286fe",
        "updatedBy": "",
        "name": "Brown Land",
        "appPackage": "Trees Brown",
        "banner": "Deep Brown Land",
        "bundleIdentifier": "ojnhrdvh58712569874235",
        "casino": {
          "id": "7a8d9f34-64d3-4641-9d66-63ad85768dd2",
          "updatedBy": "",
          "imageUrl": "http://www.google.com",
          "name": "SRS",
          "videoUrl": "http://www.facebook.com"
        },
        "casinoId": null,
        "categories": null,
        "categoryIds": null,
        "description": "Large Leaves and Flowers Brown.",
        "downloads": 12523917,
        "featured": null,
        "versionHistories": null,
        "image": "https://s3-us-west-2.amazonaws.com/Example-qa/application_images/icons/%2Fc90e9541-4f06-47cc-b136-441539845456.png",
        "keywords": null,
        "latestBuild": 16847,
        "latestVersion": "357",
        "order": null,
        "paragraph1": "Brown Land 1.",
        "paragraph2": "Brown Land 2.",
        "paragraph3": "Brown Land 3.",
        "paragraph4": "Brown Land 4.",
        "presetPriceList": null,
        "price": 6,
        "publisher": "DeepPIWood Brown.",
        "ranking": 16,
        "rating": null,
        "sliderImages": [
          "https://s3-us-west-2.amazonaws.com/Example-qa/application_images/slider/%2F0e76a747-d5ba-4bc9-818c-2f08a05f4e49.png"
        ],
        "subtitle": "Land of The Browns",
        "updated": null,
        "video": "https://s3-us-west-2.amazonaws.com/Example-qa/application_videos/%2F7cd582e0-08db-4311-940b-9b565042148a.mp4",
        "status": "SUBMITTED",
        "downloadLink": "https://s3-us-west-2.amazonaws.com/Example-qa/application_apk/%2F685e5bb8-ec9c-4356-b6b8-5d9ce473e675.apk",
        "compatibility": null,
        "sizeOnDisk": null,
        "permissionDetails": null,
        "locationSupported": null,
        "languageSupported": null,
        "additionalDetails": null,
        "tags": [
          "live",
          "windows",
          "android",
          "starter",
          "top"
        ],
        "promotionalBonus": null
      },
      {
        "id": "1d90576a-9aa0-441f-9960-0ec0164bb435",
        "updatedBy": "",
        "name": "Grey Land",
        "appPackage": "Trees Grey",
        "banner": "Deep Grey Land",
        "bundleIdentifier": "ojnhrdvh5769871536458726",
        "casino": {
          "id": "7a8d9f34-64d3-4641-9d66-63ad85768dd2",
          "updatedBy": "",
          "imageUrl": "http://www.google.com",
          "name": "SRS",
          "videoUrl": "http://www.facebook.com"
        },
        "casinoId": null,
        "categories": null,
        "categoryIds": null,
        "description": "Large Leaves and Flowers Grey.",
        "downloads": null,
        "featured": null,
        "versionHistories": null,
        "image": "https://s3-us-west-2.amazonaws.com/Example-qa/application_images/icons/%2F23e476a9-03dd-4df1-b477-9ed6f561fd74.png",
        "keywords": null,
        "latestBuild": 16847,
        "latestVersion": "357",
        "order": null,
        "paragraph1": "Grey Land 1.",
        "paragraph2": "Grey Land 2.",
        "paragraph3": "Grey Land 3.",
        "paragraph4": "Grey Land 4.",
        "presetPriceList": null,
        "price": 6,
        "publisher": "DeepPIWood Grey.",
        "ranking": null,
        "rating": null,
        "sliderImages": [
          "https://s3-us-west-2.amazonaws.com/Example-qa/application_images/slider/%2F8328b59e-6480-4aa0-b600-fef159606644.png"
        ],
        "subtitle": "Land of The Grey.",
        "updated": null,
        "video": "https://s3-us-west-2.amazonaws.com/Example-qa/application_videos/%2Fd1c10ac9-7f38-48de-84cf-e08680ef030e.mp4",
        "status": "SUBMITTED",
        "downloadLink": "https://s3-us-west-2.amazonaws.com/Example-qa/application_apk/%2Fd66f2f4b-7087-47bc-b3a5-f5924e62dcef.apk",
        "compatibility": null,
        "sizeOnDisk": null,
        "permissionDetails": null,
        "locationSupported": null,
        "languageSupported": null,
        "additionalDetails": null,
        "tags": [
          "live",
          "Windows",
          "Android",
          "I"
        ],
        "promotionalBonus": null
      }
    ],
    "casinos": [],
    "categories": []
  },
  "detail": null,
  "error": false,
  "message": "Keyword based search successful"
}

Return to top

DELETEClear Search History

Description

Allows a client to delete a user's search history.

Request Endpoint

DELETE https://<Example api server address> /search/user/{userId}/history

Parameters

Parameter Type Use Description

userId String Required Id of the user to fetch search history.

cURL syntax
curl --include \
     --request DELETE \
'https://core.dev.Example.net/api/search/user/userId/history'
Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [],
  "detail": null,
  "error": false,
  "message": "Clearing user search history successful"
}
Return to top

Parameter	Type	Use	Description
userId	String	Required	Id of the user to fetch search history.

GETFetch (Common Keywords)

Description

Allows a client to fetch common keywords from an application and casino DB.

Request Endpoint

GET https://<Example api server address>/search/{keyword}

Parameters

Parameter Type Use Description

keyword String Required Keyword search on which applications and casinos can be fetched.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/search/keyword'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [
    "App",
    "App 1.1 Version Earth Edit",
    "Application",
    "Application 1",
    "Application Recent",
    "Application recent",
    "ApplicationMusic",
    "NewApplication",
    "NewApplicationRecord",
    "UpdatedApplicationRecord",
    "sample,App",
    "sampleApp",
    "some app",
    "AppCasino"
  ],
  "detail": null,
  "error": false,
  "message": "Fetching common keyword successful"
}
Return to top

Parameter	Type	Use	Description
keyword	String	Required	Keyword search on which applications and casinos can be fetched.

GETFetch (User Search History)

Description

Allows a client to fetch a user's search history.

Request Endpoint

GET https://<Example api server address>/search/user/{userId}/history

Parameters

Parameter Type Use Description

userId String Required Id of the user to fetch a search history.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/search/user/userId/history'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [
    "poker",
    "land",
    "Example"
  ],
  "detail": null,
  "error": false,
  "message": "Fetching user search history successful"
}
Return to top

Parameter	Type	Use	Description
userId	String	Required	Id of the user to fetch a search history.

GETFetch (Filter by Category)

Description

Allows a client to fetch a user's search history.

Request Endpoint

GET https://<Example api server address>/search/category/{categoryName}/{userId}

Parameters

Parameter	Type	Use	Description
categoryName	String	Required	Name of the category on which the game apps are to be fetched.
userId	String	Required	Id of the user to fetch search history.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/search/category/categoryName/userId'

Response body

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

{
  "data": [
    {
      "id": "1a1dbdeb-89d8-480e-b007-a1948b6d4dd1",
      "updatedBy": "",
      "name": "Coconut.",
      "appPackage": "1.002",
      "banner": "Football.",
      "bundleIdentifier": "EFC8239",
      "casino": {
        "id": "f586aad2-79c9-4ed3-a05b-dd73a7268b3c",
        "updatedBy": "",
        "imageUrl": "http://www.google.com",
        "name": "Leicester Poker",
        "videoUrl": "http://www.facebook.com"
      },
      "casinoId": null,
      "categories": [
        {
          "id": "5e0e953e-b577-4b5c-81e8-a598e09e6984",
          "updatedBy": "",
          "imageUrl": "www.google.com",
          "name": "Pik Pok",
          "description": "This is a great poker game, you know",
          "videoUrl": "www.youtube.com",
          "iconUrl": null,
          "colorCode": null,
          "heroImageReference": null
        }
      ],
      "categoryIds": null,
      "description": "Fruit with hard Shell.",
      "downloads": null,
      "featured": null,
      "versionHistories": null,
      "image": null,
      "keywords": null,
      "latestBuild": 195,
      "latestVersion": "V1.22468",
      "order": null,
      "paragraph1": "zxcv48",
      "paragraph2": "asdf159",
      "paragraph3": "qwer26",
      "paragraph4": "tyui62",
      "presetPriceList": null,
      "price": 1,
      "publisher": "Casino.",
      "ranking": null,
      "rating": null,
      "sliderImages": null,
      "subtitle": "Fruit",
      "updated": null,
      "video": null,
      "status": "SUBMITTED",
      "downloadLink": null,
      "compatibility": "Windows, Android.",
      "sizeOnDisk": null,
      "permissionDetails": "Full Access.",
      "locationSupported": [
        "US",
        "Eden"
      ],
      "languageSupported": [
        "English",
        "German",
        "French"
      ],
      "additionalDetails": "Awesome Application.",
      "tags": null,
      "promotionalBonus": null
    }
  ],
  "detail": null,
  "error": false,
  "message": "Fetching applications by category successful"
}

Return to top

GETFetch (Trending)

Description

Allows a client to fetch a popular search.

Request Endpoint

GET https://<Example api server address>/search/popular

Parameters

None.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/search/popular'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [
    "app",
    "rec",
    "new",
    "shru"
  ],
  "detail": null,
  "error": false,
  "message": "Fetching popular search successful"
}
Return to top

GETFetch Related Search Keywords

Description

Fetches applications downloaded by other users.

Request Endpoint

GET https://<Example api server address>/search/related/{keyword}

Parameters

Parameter Type Use Description

keyword String Required Keyword for related search queries that are to be returned.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/search/related/keyword'
Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [
    "lotbwin"
  ],
  "detail": null,
  "error": false,
  "message": "Fetching related keywords successful"
}
Return to top