Introduction

Welcome to Nuuvem Store Api Docs!

The API was created by the Nuuvem team and you can use it to do almost everything that you can do on our store using the HTML interface.

Please leave any feedback you have for us on our documentation repository on the issue tracker page.

The base API url is: https://api.nuuvem.com. Remeber to put it before each request path params.

Authentication

To verify if the token is valid, you can use the following endpoint:

curl -X GET 'https://api.nuuvem.com/v3/no-country-ping' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json"

The above command returns the following response if the token is correct and the user is enabled to use the API:

{
  "ping": "pong",
  "text": "Hello World!",
  "store": null
}

The Store API uses API keys to allow access to it. For now, while this API is in beta, only selected partners are allowed access. You can request API access via our support page. Please explain who you (and your company, if any) are, what usage of the API you would need and how it would be beneficial to you.

After API access is granted (we'll let you know via email), you can register a new Store API key at your account details page. You will need a Nuuvem store account.

It is expected that the requester include the API key in all requests to the server in an Authorization header that looks like the following:

Authorization: Bearer token-value

We also expect you to pass a header informing the correct media type supported by our API, which is:

Accept: application/vnd.api+json

You can click here for more information about JSON API.

You must replace token-value with your personal API key.

  export NUUVEM_API_TOKEN="token-value"

To simplify the examples for subsequent requests, consider exporting your API key to an environment variable named NUUVEM_API_TOKEN.

Localization

The Store API supports localization for error messages and other strings for all resources. Localization is defined in each request with Accept-Language header. Accepted values are currently:

en - English (default)
es - Spanish
pt - Portuguese

We also support quality params for the Accept-Language language tags. Each language-range can be given an associated quality value representing an estimate of the user's preference for the languages. For example:

Accept-Language: pt, en-gb;q=0.8, es;q=0.7

That would mean: "I prefer Portuguese, but will accept British English and Spanish".

All responses will contain the Content-Language header, with the value informing the selected language of all localized attributes on the response (if any).

Pagination

In the Store API, pagination is implemented according to the JSONAPI pagination specification for endpoints that return collections of resources. Not all endpoints support pagination, but for those that do, pagination details are provided in the response.

You can find more information about each key on the table below.

Name	Description
`meta`	Key used to include non-standard `meta-information
`meta > pagination`	Contains pagination-related information for the current resource
`meta > pagination > current`	Indicates the current page number
`meta > pagination > first`	Indicates the first page number
`meta > pagination > prev`	Indicates the previous page number
`meta > pagination > next`	Indicates the next page number, if available
`meta > pagination > last`	Indicates the last page number
`meta > pagination > records`	Represents the total number of records available for the current resource
`links`	Contains `links to related resources
`links > self`	URL representing the current request made by the user to the server
`links > current`	URL representing the current page of the resource returned by the server
`links > first`	URL representing the first page of the resource returned by the server
`links > prev`	URL representing the previous page of the resource returned by the server
`links > next`	URL representing the next page of the resource, if available
`links > last`	URL representing the last page of the resource

This structure ensures that clients can efficiently navigate through large sets of data, retrieve specific pages, and understand the overall size and structure of the dataset being accessed.

Errors

You can read this section to obtain a list of possible errors, including their HTTP status codes and additional attributes.

The Store API currently has the following errors:

HTTP Response Status	Error Name	Description
401	Unauthorized	Invalid Authentication Token.
403	Forbidden	You are not authorized to perform this action.
404	Not Found	The resource could not be found on the server.
406	Not Acceptable	The server cannot produce a response matching the list acceptable values defined in the request headers.
406	Unsupported Language	The requested language '`<language-code>`' is not supported. Please use one of the supported languages: 'pt, en, es'.
415	Unsupported Media Type	Invalid Accept Header. Use application/vnd.api+json to perform this request.
422	Country is not valid	The requested country code '`<country-code>`' is invalid. Please provide a valid country code from ISO 3166-1 A-2.
422	Unsupported Country	The requested country code '`<country-code>`' is not currently supported. 'Please choose an available country.

Understanding errors

Example error response:

{
  "errors": [
    {
      "title": "Unauthorized",
      "detail": "Invalid Authentication Token",
      "status": "401",
      "source": "/root",
      "code": "internal_code_error_string",
      "links": {
        "service-doc": "https://docs.nuuvem.com/#errors"
      }
    }
  ]
}

Error responses are as descriptive as possible, and sometimes contain extra fields to help clients understand why the error occurred.

Below you'll be able to find more about each key in the error response payload.

Key	Description
`title`	A short, human-readable summary of the problem
`detail`	A human-readable explanation specific to this occurrence of the problem
`status`	The HTTP status code applicable to this problem, expressed as a string value
`source`	An object containing references to the primary source of the error
`code`	An application-specific error code, expressed as a string value
`links`	Representation of useful internal links that points to resources or the service documentation
`links > service-doc`	Identifies service documentation for the context that is primarily intended for human consumption

Custom error codes

Custom error codes are descriptive internal error strings that represent specific application-level errors which do not have a corresponding HTTP status code. Instead, these custom codes reuse existing HTTP status codes and provide additional context through the code key in the response payload.

Below is a list of our custom error codes:

Value	Description
`product_package_not_supported_yet`	This error indicates that the API currently does not support Product Packages. When you request a product ID that corresponds to a Product Package, you will receive an error with this code.

Countries

The Store API requires the user to inform a valid and supported country in some endpoints as a URL path param. At the time of your request, you can call the LIST COUNTRIES endpoint to get the currently available and supported list of countries.

This section description provides information about the request method, headers, response status, content type, and body structure, helping users understand how to interact with the /v3/countries endpoint and interpret the response.

Country object

Detailed Country resource attributes descriptions with payload example.

{
  "id": "076",
  "type": "countries",
  "attributes": {
    "alpha2": "BR",
    "name": "Brazil"
  }
}

ATTRIBUTES

Name	Description
`id`	Numeric ISO 3166-1 code
`type`	Resource type
`alpha2`	Country code in ISO 3166-1 A-2 format
`name`	Country name

GET: List Countries

Get the list of countries:

curl -X GET 'https://api.nuuvem.com/v3/countries' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "data": [
    {
      "id": "076",
      "type": "country",
      "attributes": {
        "alpha2": "BR",
        "name": "Brazil"
      }
    },
    ...
  ]
}

GET /v3/countries

Parameter	Default	Description

You don't have to supply any parameters for this endpoint.

See noteworthy response attributes.

Products

The products endpoints collection encapsulates the representation of our offerings as showcased on the Nuuvem store. Within this section, you will discover valuable resources to efficiently manage requests related to product endpoints.

Product object

Detailed Product resource attributes descriptions with payload example.

{
  "id": "557dbc2c69702d0a9c36d900",
  "type": "products",
  "attributes": {
    "name": "Castlevania: Lords of Shadow 2",
    "sku": 1724,
    "slug": "castlevania-lords-of-shadow-2",
    "store_url": "https://www.nuuvem.com/br-en/item/castlevania-lords-of-shadow-2",
    "purchasable": true,
    "pricing": {
      "currency": "BRL",
      "full_amount": 72.99,
      "sale_amount": 72.99,
      "discount_percentage": 0,
      "valid_from": "2017-08-25T19:32:36Z",
      "valid_until": null,
      "full_amount_formatted": "R$ 72,99",
      "sale_amount_formatted": "R$ 72,99"
    },
    "images": {
      "background": {
        "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/backgrounds/zjindmnjd11jv45umfou.jpg"
      },
      "banner": {
        "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/banners/hwuv5id0osnjsh3wmxkl.jpg"
      },
      "boxshot": {
        "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/boxshots/ebbnueufjev1w72t1h4k.jpg"
      },
      "sharing": {
        "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/sharing_images/s61wdikrzbzvgtxpxtjm.jpg"
      },
      "screenshots": [
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/hszxk81vqrawq5kyswfw.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/amztoqpxldan5jkrhezx.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/xced9eitne6fcqlwa4sp.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/vtqlrsrvmqcf8fevsf9e.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/ncj8lqejtyh8mz4ts9xt.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/z65facedrq1fpvqhv3vo.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/awvasfgbqurbqzmehmim.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/aqrcdndexnbymgkg6duk.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/vchigx7deexriaohtn1n.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/xhz9ixjuth2o8j3xuidk.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/trgmo34kvodri9x99fih.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/kbxzshagypghvtmihsut.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/pnoy4gn9fryirwygbhet.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/rsjppukgwuleo6sylmvh.jpg"
        },
        {
          "url": "https://assets.nuuvem.com/image/upload/v1/products/557dbc2a69702d0a9cc7d800/screenshots/rgcre8zo6exrqcktxawc.jpg"
        }
      ]
    },
    "about": "<p>Dracula, weak and yearning release from immortality, ...himself!</p>\r\n",
    "short_info": null,
    "important_information": null,
    "pre_sale_information": null,
    "early_play_information": null,
    "bonus_content": null,
    "highlights": null,
    "footer_notes": "<p>&copy; 2014 KONAMI Digital Entertainment. ... work that forms part of this product is prohibited.</p>\r\n",
    "system_requirements": {
      "windows": {
        "minimum": {
          "os": "Windows XP SP3",
          "storage": "10 GB",
          "processor": "Intel Core 2 Duo / AMD 2.4GHz",
          "memory": "2 GB",
          "graphics": "512 MB VRAM",
          "sound_card": null,
          "directx": "9.0",
          "network": null
        },
        "recommended": {
          "os": "Windows 7",
          "storage": "10 GB",
          "processor": "Quad Core",
          "memory": "2 GB",
          "graphics": "1 GB VRAM",
          "sound_card": null,
          "directx": "11.0",
          "network": null
        }
      }
    },
    "system_requirements_notes": null,
    "supported_locales": [
      {
        "locale": "pt-BR",
        "interface": true,
        "audio": false,
        "subtitle": false
      },
      {
        "locale": "en",
        "interface": true,
        "audio": true,
        "subtitle": true
      },
      {
        "locale": "de",
        "interface": true,
        "audio": false,
        "subtitle": false
      },
      {
        "locale": "es",
        "interface": true,
        "audio": false,
        "subtitle": false
      },
      {
        "locale": "fr",
        "interface": true,
        "audio": false,
        "subtitle": false
      },
      {
        "locale": "it",
        "interface": true,
        "audio": false,
        "subtitle": false
      }
    ],
    "parental_ratings": [
      {
        "organization": "ClassInd",
        "classification": "Not recommended for people under 18",
        "content_descriptors": [
          "Extreme Violence",
          "Inappropriate Language"
        ]
      }
    ],
    "embeds": [
      {
        "url": "http://www.youtube.com/watch?v=BhutLDpjRDA",
        "thumbnail": "https://assets.nuuvem.com/image/upload/t_video_overlay_transformation/v1/products/embeds/thumbnails/yv2jtpew8gkrkufcpzgx.jpg",
        "code": "<iframe src='//www.youtube.com/embed/BhutLDpjRDA' frameborder='0' allow='autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture' allowfullscreen></iframe>",
        "type": "video"
      }
    ],
    "release_date": "2014-02-25T03:00:00Z"
  },
  "relationships": {
    "categories": {
      "data": [
        {
          "id": "557ca3cf69702d235300003d",
          "type": "categories"
        },
        {
          "id": "557ca3cf69702d2353000041",
          "type": "categories"
        },
        {
          "id": "563cfdf669702d5edd000164",
          "type": "categories"
        }
      ]
    },
    "platforms": {
      "data": [
        {
          "id": "5e3c5fe6cb8db15d5aff3180",
          "type": "platforms"
        }
      ]
    },
    "systems": {
      "data": [
        {
          "id": "557ca3cf69702d2353000018",
          "type": "systems"
        }
      ]
    },
    "activations": {
      "data": [
        {
          "id": "557ca3cf69702d235300005a",
          "type": "activations"
        }
      ]
    },
    "developers": {
      "data": [
        {
          "id": "5a3970db88102444ef00021b",
          "type": "developers"
        }
      ]
    },
    "publishers": {
      "data": [
        {
          "id": "557ce4bf69702d0c6e1e0100",
          "type": "publishers"
        }
      ]
    },
    "product_type": {
      "data": {
        "id": "557ca3cf69702d235300000b",
        "type": "product_types"
      }
    }
  },
  "links": {
    "self": "https://api.nuuvem.com/v3/br/products/557dbc2c69702d0a9c36d900"
  },
  "included": [
    {
      "id": "557ca3cf69702d235300003d",
      "type": "categories",
      "attributes": {
        "name": "Action"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/categories/557ca3cf69702d235300003d"
      }
    },
    {
      "id": "557ca3cf69702d2353000041",
      "type": "categories",
      "attributes": {
        "name": "Adventure"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/categories/557ca3cf69702d2353000041"
      }
    },
    {
      "id": "563cfdf669702d5edd000164",
      "type": "categories",
      "attributes": {
        "name": "Hack and Slash"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/categories/563cfdf669702d5edd000164"
      }
    },
    {
      "id": "5e3c5fe6cb8db15d5aff3180",
      "type": "platforms",
      "attributes": {
        "name": "PC"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/platforms/5e3c5fe6cb8db15d5aff3180"
      }
    },
    {
      "id": "557ca3cf69702d2353000018",
      "type": "systems",
      "attributes": {
        "name": "Windows"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/systems/557ca3cf69702d2353000018"
      }
    },
    {
      "id": "557ca3cf69702d235300005a",
      "type": "activations",
      "attributes": {
        "name": "Steam"
      },
      "links": {
        "self": "https://api.nuuvem.host/v3/activations/557ca3cf69702d235300005a"
      }
    },
    {
      "id": "5a3970db88102444ef00021b",
      "type": "developers",
      "attributes": {
        "name": "MercurySteam"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/developers/5a3970db88102444ef00021b"
      }
    },
    {
      "id": "557ce4bf69702d0c6e1e0100",
      "type": "publishers",
      "attributes": {
        "name": "Konami Digital Entertainment"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/publishers/557ce4bf69702d0c6e1e0100"
      }
    },
    {
      "id": "557ca3cf69702d235300000b",
      "type": "product_types",
      "attributes": {
        "name": "Standard"
      },
      "links": {
        "self": "https://api.nuuvem.com/v3/product_types/557ca3cf69702d235300000b"
      }
    }
  ]
}

ATTRIBUTES

Name	Description
`id`	String representing the product id
`type`	Resource type
`name`	Name of the product
`sku`	Integer value that represents the product
`slug`	Represents the parameterized product name
`store_url`	URL of the product on Nuuvem store
`purchasable`	Indicates whether the product is available for purchase or not for the given country code url param
`pricing`	Contains detailed pricing information for a product, including currency, amounts, discounts, and validity periods
`images`	List of all product images
`about`	Description of the product as rich text
`short_info`	Short description of the product as rich text
`important_information`	Important information about the product as rich text
`pre_sale_information`	Information about pre-sale of the product as rich text
`bonus_content`	Bonus information about the product as rich text
`highlights`	Highlights about the product as rich text
`footer_notes`	Footer notes about the product as rich text
`system_requirements`	Hardware and software specifications required to play the game
`system_requirements_notes`	Requirements notes due to some game specificity
`supported_locales`	Languages supported by the game
`parental_ratings`	Parental ratings recommended for the game, related to the supplied `country-code`
`embeds`	List of embedded multimedia
`release_date`	Game release date in the ISO 8601 format for the given country code or an approximate date. E.g.: "End of 2025"

RELATIONSHIPS

Represent all product system-related objects.

A relationship is represented by a key named after the related object, e.g., 'Categories', and each relationship has an array with key-value pairs of id and type.

LINKS

Name	Description
`self`	The API url for product resources provides access of product data

INCLUDED

Returns a list of serialized objects from relationships. The list below contains all related product objects.

Categories
Platforms
Systems
Activations
Product Types
Developers
Publishers

GET: List products

GET /v3/:country-code/products

Get a list of products.

curl -i -X GET 'https://api.nuuvem.com/v3/br/products' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "data": [
    {
      "id": "557dba1f69702d0a9cc70000",
      "type": "products",
      "attributes": {
        "name": "Kairo",
        // Same attributes as the product object details section
      }
    },
    {
      "id": "557dba2269702d0a9c250100",
      "type": "products",
      "attributes": {
        "name": "Manhunter",
        // Same attributes as the product object details section
      }
    }
  ],
  "meta": {
    "pagination": {
      "current": 2,
      "first": 1,
      "prev": 1,
      "next": 3,
      "last": 3080,
      "records": 6159
    }
  },
  "links": {
    "self": "https://api.nuuvem.com/v3/br/products?page%5Bsize%5D=2&page%5Bnumber%5D=2",
    "current": "https://api.nuuvem.com/v3/br/products?page[number]=2&page[size]=2",
    "first": "https://api.nuuvem.com/v3/br/products?page[number]=1&page[size]=2",
    "prev": "https://api.nuuvem.com/v3/br/products?page[number]=1&page[size]=2",
    "next": "https://api.nuuvem.com/v3/br/products?page[number]=3&page[size]=2",
    "last": "https://api.nuuvem.com/v3/br/products?page[number]=3080&page[size]=2"
  }
}

Note: All fields will be returned regardless of whether they contain information or are null, where null represents the absence of information.

URL PARAMETERS

Parameter	Default	Description
`country-code`	none	A valid ISO 3166-1 A-2 country code from LIST COUNTRIES

QUERY PARAMETERS

Parameter	Default	Description
`page[size]`	20	The number of products to retrieve per page. Maximum of 50 products per page.
`page[number]`	1	The page number you wish to retrieve.

See noteworthy response attributes.

GET: Retrieve product

GET /v3/:country-code/products/:id

Get a product.

curl -i -X GET 'https://api.nuuvem.com/v3/br/products/557dbc2c69702d0a9c36d900' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": "557dbc2c69702d0a9c36d900",
    "type": "products",
    "attributes": {
      "name": "Castlevania: Lords of Shadow 2",
      // Same attributes as the product object details section
    }
  }
}

Note: All fields will be returned regardless of whether they contain information or are null, where null represents the absence of information.

URL PARAMETERS

Parameter	Default	Description
`country-code`	none	A valid ISO 3166-1 A-2 country code from LIST COUNTRIES
`id`	none	The requested product ID

See noteworthy response attributes.

Name	Description
`id`	String representing the category id
`type`	Resource type
`name`	Localized string representing the category name

Parameter	Default	Description
`id`	none	The requested category ID

Name	Description
`self`	The API url for category resources provides access of game category data

Platforms

Video game platforms, such as PC, Xbox, PlayStation, Nintendo Switch and Mobile, determine the devices a game is compatible with.

Platform object

Detailed Platform resource attributes descriptions with payload example.

{
  "id": "5e3c5fe6cb8db15d5aff3180",
  "type": "platforms",
  "attributes": {
    "name": "PC"
  }
}

ATTRIBUTES

Name	Description
`id`	String representing the platform id
`type`	Resource type
`name`	Localized string representing the platform name

GET: Retrieve platform

GET /v3/platforms/:id

Get a platform.

curl -i -X GET 'https://api.nuuvem.com/v3/platforms/5e3c5fe6cb8db15d5aff3180' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": "5e3c5fe6cb8db15d5aff3180",
    "type": "platforms",
    "attributes": {
      "name": "PC"
    },
    "links": {
      "self": "https://api.nuuvem.com/v3/platforms/5e3c5fe6cb8db15d5aff3180"
    }
  }
}

Parameter	Default	Description
`id`	none	The requested platform ID

LINKS

Name	Description
`self`	URL for the selected platform resource on the API

Systems

Operating systems the game is supported on, like Windows, macOS, and others.

System object

Detailed descriptions of system resource attributes with example payloads.

{
  "id": "557ca3cf69702d2353000018",
  "type": "systems",
  "attributes": {
    "name": "Windows"
  }
}

ATTRIBUTES

Name	Description
`id`	String representing the system id
`type`	Resource type
`name`	String representing the system name

GET: Retrieve system

GET /v3/systems/:id

Get a system.

curl -i -X GET 'https://api.nuuvem.com/v3/systems/557ca3cf69702d2353000018' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": "557ca3cf69702d2353000018",
    "type": "systems",
    "attributes": {
      "name": "Windows"
    },
    "links": {
      "self": "https://api.nuuvem.com/v3/systems/557ca3cf69702d2353000018"
    }
  }
}

Parameter	Default	Description
`id`	none	The requested system ID

LINKS

Name	Description
`self`	URL for the selected system resource on the API

Activations

Platforms where you can activate the game, such as Steam, Epic, and others.

Activation object

Detailed descriptions of platform activation resource attributes with example payload.

{
  "id": "557ca3cf69702d235300005a",
  "type": "activations",
  "attributes": {
    "name": "Steam"
  }
}

ATTRIBUTES

Name	Description
`id`	String representing the activation id
`type`	Resource type
`name`	String representing the activation name

GET: Retrieve activation

GET /v3/activations/:id

Get an activation.

curl -i -X GET 'https://api.nuuvem.com/v3/activations/557ca3cf69702d235300005a' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": "557ca3cf69702d235300005a",
    "type": "activations",
    "attributes": {
      "name": "Windows"
    },
    "links": {
      "self": "https://api.nuuvem.com/v3/activations/557ca3cf69702d235300005a"
    }
  }
}

Parameter	Default	Description
`id`	none	The requested activation ID

LINKS

Name	Description
`self`	URL for the selected activation resource on the API

Product Types

Product type identifies the game's version, such as standard, DLC, premium editions, or others.

Product Type object

Detailed descriptions of product type resource attributes with example payload.

{
  "id": "557ca3cf69702d235300000b",
  "type": "product_types",
  "attributes": {
    "name": "Standard"
  }
}

ATTRIBUTES

Name	Description
`id`	String representing the product type id
`type`	Resource type
`name`	Localized string representing the product type name

GET: Retrieve Product Type

GET /v3/product_types/:id

Get a product type.

curl -i -X GET 'https://api.nuuvem.com/v3/product_types/557ca3cf69702d235300000b' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "id": "557ca3cf69702d235300000b",
  "type": "product_types",
  "attributes": {
    "name": "Standard"
  },
  "links": {
    "self": "https://api.nuuvem.com/v3/product_types/557ca3cf69702d235300000b"
  }
}

Parameter	Default	Description
`id`	none	The requested product type ID

LINKS

Name	Description
`self`	URL for the selected product type resource on the API

Developers

Represents studios responsible for game development, such as Dumativa Game Studio, Cygames, and others.

Developer object

Detailed descriptions of developers resource attributes with example payload.

{
  "id": "5a3970db88102444ef00021b",
  "type": "developers",
  "attributes": {
    "name": "MercurySteam"
  }
}

ATTRIBUTES

Name	Description
`id`	String representing the developer id
`type`	Resource type
`name`	String representing the developer name

GET: Retrieve Developer

GET /v3/developers/:id

Get a developer.

curl -i -X GET 'https://api.nuuvem.com/v3/developers/5a3970db88102444ef00021b' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "id": "5a3970db88102444ef00021b",
  "type": "developers",
  "attributes": {
    "name": "MercurySteam"
  },
  "links": {
    "self": "https://api.nuuvem.com/v3/developers/5a3970db88102444ef00021b"
  }
}

Parameter	Default	Description
`id`	none	The requested developer ID

LINKS

Name	Description
`self`	URL for the selected developer resource on the API

Publishers

Represents companies responsible for game publishing and distribution, such as Electronic Arts (EA), Activision, Ubisoft, and Nintendo.

Publisher object

Detailed descriptions of publisher resource attributes with example payload.

{
  "id": "557ce4bf69702d0c6e1e0100",
  "type": "publishers",
  "attributes": {
    "name": "Konami Digital Entertainment"
  }
}

ATTRIBUTES

Name	Description
`id`	String representing the publisher id
`type`	Resource type
`name`	String representing the publisher name

GET: Retrieve Publisher

GET /v3/publishers/:id

Get a publisher.

curl -i -X GET 'https://api.nuuvem.com/v3/publishers/557ce4bf69702d0c6e1e0100' \
  -H "Authorization: Bearer ${NUUVEM_API_TOKEN}" \
  -H "Accept: application/vnd.api+json" \
  -H "Accept-Language: en"

The above command returns the following response body and headers:

HTTP/2.0 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
Content-Language: en

{
  "id": "557ce4bf69702d0c6e1e0100",
  "type": "publishers",
  "attributes": {
    "name": "Konami Digital Entertainment"
  },
  "links": {
    "self": "https://api.nuuvem.com/v3/publishers/557ce4bf69702d0c6e1e0100"
  }
}

Parameter	Default	Description
`id`	none	The requested publisher ID

LINKS

Name	Description
`self`	URL for the selected publisher resource on the API

Introduction

Authentication

Localization

Errors

Understanding errors

Custom error codes

Countries

Country object

GET: List Countries

Products

Product object

GET: List products

GET: Retrieve product

Categories

Category object

GET: Retrieve category

Platforms

Platform object

GET: Retrieve platform

Systems

System object

GET: Retrieve system

Activations

Activation object

GET: Retrieve activation

Product Types

Product Type object

GET: Retrieve Product Type

Developers

Developer object

GET: Retrieve Developer

Publishers

Publisher object

GET: Retrieve Publisher