Saltar para o conteúdo
/
Criar região

Catalog API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog API fornece endpoints para gerenciar o catálogo da sua loja no jogo e processar compras. Use os endpoints para configurar itens virtuais, moedas virtuais, chaves do jogo, conjuntos, fluxos de carrinho e pagamento, atributos de itens e importar itens de fontes externas.

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/
https://store.xsolla.com/api/

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Catálogo

Operações

Direito

Operações

Admin

Operações

Admin

Operações

Catálogo

Operações

Carrinho (lado do cliente)

Operações

Carrinho (lado do servidor)

Operações

Pagamento (lado do cliente)

Operações

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Gestão

Operações

Admin

Operações

Webhooks

Operações

Reservas

Operações

Comerciante

Operações

Catálogo

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

Operações

Regiões comuns

Operações

Obter lista de regiõesServer-sideAdmin

Pedido

Obtém lista de regiões.

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
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/admin/region

Respostas

Lista de regiões recebida com sucesso.

Corpoapplication/json
regionsArray of objects(Regions_200-region-short-model)
Resposta
application/json
{
  "regions": [
    { … },
    { … }
  ]
}

Criar regiãoServer-sideAdmin

Pedido

Cria região.

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
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 POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Respostas

Região criada com sucesso.

Corpoapplication/json
region_idinteger(Regions_region_id)

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

Exemplo: 42
Resposta
application/json
{
  "region_id": 42
}

Excluir regiãoServer-sideAdmin

Pedido

Exclui uma região específica.

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 DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/admin/region/42

Respostas

Região excluída com sucesso.

Corpo
Resposta
Sem conteúdo

Admin

Operações