Integrate via the All Games API

Gamezop's All Games API allows you to access data on our games so you can list them in your own UI.

The All Games API lets you access a list of games and associated details (description, screenshots etc.) so that you can directly launch games from your app / site instead of sending users to the Gamezop Game Centre.

Making the request

API endpoint

GET https://api.gamezop.com/v3/games

Headers

Name
Description

Authorization: Bearer*

You must ask your Gamezop Account Manager to get your Bearer token created for you. You can then find the Bearer token for this API under Settings & Admin > API Tokens within the Gamezop Business Dashboard.

Query parameters

Name
Description

lang

ISO 639-1 language code. A full list of valid language codes is available in the IANA Language Subtag Registry (filter for Type: language)

Understanding the response

HTTP response codes

The API provides a JSON response with a data object. This, in turn, contains an array of JSON objects, each representing data on 1 game.

Expected response body:

This sample response contains 1 single game object. Your API response will contain 1 game object for each game enabled for your Property ID.

{
  "data": [
    {
      "code": "Ey5Wzu1MZ9l",
      "url": "https://www.gamezop.com/g/Ey5Wzu1MZ9l",
      "name": "Hextris",
      "description": "Rotate the Hexagon to match colours, prevent the blocks from stacking on incorrect counterparts.",
      "screen_orientation": "portrait",
      "has_integrated_ads": true,
      "category": {
        "id": 1,
        "name": "Arcade"
      },
      "images": {
        "cover": "https://static.gamezop.com/Ey5Wzu1MZ9l/cover.jpg",
        "brick": "https://static.gamezop.com/Ey5Wzu1MZ9l/brick.png",
        "thumb": "https://static.gamezop.com/Ey5Wzu1MZ9l/thumb.png",
        "wall": "https://static.gamezop.com/Ey5Wzu1MZ9l/wall.png",
        "square": "https://static.gamezop.com/Ey5Wzu1MZ9l/square.png",
        "screenshots": [
          "https://static.gamezop.com/Ey5Wzu1MZ9l/game-1.png",
          "https://static.gamezop.com/Ey5Wzu1MZ9l/game-2.png",
          "https://static.gamezop.com/Ey5Wzu1MZ9l/game-3.png"
        ]
      }
    }
  ]
}

Response body

The table below explains each of the fields the API returns within a game object.

Key
Description

code

A unique alphanumeric identifier for the game

url

The URL to the game that you can embed in your app or website

name

A name object for the game, capturing the game name. If you request data for any specific language, this field will contain the name of the game in that language. If we do not have the game name in the requested language, the English name of the game will be returned.

description

A short description object of the game that can be displayed to the end-user. If you request data for any specific language, this field will contain the description of the game in that language. If we do not have the game description in the requested language, the English description of the game will be returned.

screen_orientation

Possible values

  • portrait

  • landscape

  • responsive

has_integrated_ads

If true, it means that this game has integrated ads which cannot be removed. Integrated ads are different from the ads that come before or during gameplay.

Integrated ads are those ads which users opt-in to watch. For instance, users may have an option to get an extra life by watching an ad. If the value for has_integrated_ads is false, it means that the game does not give users any option to watch an ad. If you are working with us on a model where you have ads disabled, you should avoid using games where this value is true.

category

The category to which the game belongs. category is a JSON object, containing 2 values: id and name.

A game will always belong to only one of these categories:

  • Arcade | id: 1

  • Action | id: 2

  • Sports & Racing | id: 3

  • Strategy | id: 4

  • Puzzle & Logic | id: 5

  • Adventure | id: 7

If you request data for any specific language, category.name will contain the game's category in that language. If we do not have the category name in the requested language, the English name for the game category will be returned.

images

An assets object for the game. This contains several assets that can be used as promotional banners:

  • cover: URL to a 600x492 pixels image asset

  • brick: URL to a 310x150 pixels image asset

  • wall: URL to a 1024x500 pixels image asset

  • thumb: URL to a

  • square: URL to a

  • screenshots: An array of 3 URLs with screenshots from the game

To find more assets for any particular game, enter the code from the API for that game in our Creatives Library's search bar.

If you wish to open Gamezop's games within an iframe in your website, ask your Gamezop Account Manager to whitelist your Property ID for iframe usage. By default, Gamezop games do not work within iframes.

If you're looking for deeper integration guides, such as those for leaderboards, or 1v1 multiplayer matches, check our advanced guides linked below.

💪Advanced guides

Last updated

Was this helpful?