Saltar para o conteúdo

Visão geral

  • Versão: 2.0.0
  • Servidores: https://store.xsolla.com/api
  • Contate-nos por e-mail
  • URL de contato: https://xsolla.com/
  • Versão TLS necessária: 1.2

A Catalog API permite que você configure um catálogo de itens de jogo no lado da Xsolla e exibir o catálogo aos usuários na sua loja.

A API permite que você gerencie as seguintes entidades de catálogo:

  • Itens virtuais — itens de jogo tais como armas, visuais e reforços.
  • Moedas virtuais — dinheiro virtual utilizado para comprar bens virtuais.
  • Pacotes de moedas virtuais — conjuntos pré-definidos de moedas virtuais.
  • Conjuntos — pacotes combinados de itens virtuais, moedas ou chaves de jogo vendidas como um único SKU.
  • Chaves de jogo — chaves para jogos e DLCs distribuídos via plataformas como o Steam ou outros provedores de DRM.
  • Grupos — agrupamentos lógicos para organizar e filtrar itens dentro do catálogo.

Chamadas de API

A API divide-se nos seguintes grupos:

  • Admin — chamadas para criar, atualizar, excluir e configurar itens de catálogo e grupos. Autenticada via autenticação de acesso básica com seu comerciante ou credenciais do projeto. Não se destina a uso em vitrines.
  • Catalog — chamadas para recuperar itens e construir vitrines personalizadas para usuários finais. Desenvolvida para gerenciar cenários de carga alta. Suporta a autorização opcional de JWT de usuários para retornar dados personalizados, tais como limites específicos aos usuários e promoções ativas.
Transferir a descrição da OpenAPI
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações

Catálogo

Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos.

Operações
Operações

Pedido

Obtém região específica.

Você pode usar uma região para gerenciar suas restrições regionais.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
region_idintegerobrigatório

ID de região. Identificador de região exclusivo dentro do projeto.

Exemplo: 42
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/region/42

Respostas

A região especificada foi recebida com sucesso.

Corpoapplication/json
countriesArray of strings(Regions_countries)

Lista de países a serem adicionados em uma região.
Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: ["JP", "CN", "VN"]

idinteger(Regions_region_id)

ID de região. Identificador de região exclusivo dentro do projeto.

Exemplo: 42
nameobject(Regions_name)

Nome da região. Deve conter pares chave/valor onde chave é uma localidade com o formato "^[a-z]{2}-[A-Z]{2}$", e o valor sendo uma cadeia de caracteres.

Padrão {"de-DE":"Asien","en-US":"Asia"}
Exemplo: {"de-DE":"Asien","en-US":"Asia"}
Resposta
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }

Pedido

Atualiza uma região específica.

Você pode usar uma região para gerenciar suas restrições regionais.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
region_idintegerobrigatório

ID de região. Identificador de região exclusivo dentro do projeto.

Exemplo: 42
Corpoapplication/json
countriesArray of strings(Regions_countries)obrigatório

Lista de países a serem adicionados em uma região.
Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: ["JP", "CN", "VN"]

nameobject(Regions_name)obrigatório

Nome da região. Deve conter pares chave/valor onde chave é uma localidade com o formato "^[a-z]{2}-[A-Z]{2}$", e o valor sendo uma cadeia de caracteres.

Padrão {"de-DE":"Asien","en-US":"Asia"}
Exemplo: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringpropriedade adicional
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/region/42 \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Respostas

Região atualizada com sucesso.

Corpo
Resposta
Sem conteúdo
Operações