Saltar para o conteúdo
/
Importar itens via arquiv...

API Shop Builder (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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

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

Admin

Operações

Catálogo personalizado

Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.

Para promoções personalizadas, consulte a seção Promotions.

Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.

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

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

Catálogo

Operações

Direito

Operações

Admin

Operações

Comum

Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Códigos promocionais

Esta API permite gerenciar códigos promocionais.

Operações

Ofertas de catálogo exclusivas

Essa API permite que você gerencie ofertas de catálogo exclusivas.

Operações

Descontos

Esta API permite-lhe gerir promoções de desconto.

Operações

Bônus

Esta API permite gerenciar promoções de bônus.

Operações

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Gestão

Operações

Admin

Operações

Cliente

Operações

Cliente de clãs

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Obter status da importação de itensServer-sideAdmin

Pedido

Recupera informações sobre o andamento da importação de itens para o projeto. Essa chamada de API recupera dados da última importação realizada por meio da Conta de Distribuidor ou da API.

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/shop-builder/v1/admin/projects/44056/connectors/import_items/import/status

Respostas

O status da importação foi recuperado com êxito.

Corpoapplication/json
date_completedstring

O carimbo de data de conclusão da operação de importação no fuso horário GMT+3. Se a importação foi interrompida devido a um erro e nenhum item foi importado, será retornada uma string vazia.

Exemplo: "2024-11-19T15:27:31+03:00"
date_createdstring

O carimbo de data da operação de criação de importação no fuso horário GMT+3.

Exemplo: "2024-11-19T14:27:31+03:00"
date_updatedstring

O carimbo de data em que a importação foi interrompida devido a um erro no fuso horário GMT+3.

Exemplo: "2024-11-19T15:27:31+03:00"
errorstring

Descrição do erro geral de importação.

error_codestring

O código do erro de importação geral.

progressinteger

O progresso da execução da importação em porcentagem.

Exemplo: 100
resultobject

Um objeto com dados sobre os resultados da importação e erros de importação para o SKU de itens específicos.

Exemplo: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
statusstring

Status de importação.

Enum ValorDescrição
done

A importação foi bem-sucedida.

error

Devido a erros, a importação não foi concluída ou foi concluída apenas parcialmente.

initialized

A importação foi iniciada.

process

A importação está em progresso.

Exemplo: "error"
Resposta
application/json
{
  "date_completed": "2024-11-19T15:27:31+03:00",
  "date_created": "2024-11-19T14:27:31+03:00",
  "date_updated": "2024-11-19T15:27:31+03:00",
  "error": null,
  "error_code": null,
  "progress": 100,
  "result": {
    "errors_by_sku": [ … ],
    "errors_count": 2,
    "total_entities_count": 10
  },
  "status": "error"
}

Importar itens via arquivo JSONServer-sideAdmin

Pedido

Importa itens para a Store a partir de um arquivo JSON por meio da URL especificada. Consulte a documentação para obter mais informações sobre a importação de um arquivo JSON.

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
connector_external_idstringobrigatório

Um valor fixo que especifica o tipo de operação para importar itens.

Valor"import_items"
file_urlstringobrigatório

A URL de um arquivo com dados no formato JSON. O arquivo deve ser hospedado em um serviço de armazenamento com acesso público. Você pode baixar o modelo de arquivo na Conta de Distribuidor na seção Store > Virtual Items > Catalog Management > Import Items (JSON).

Exemplo: "https://my-bucket.s3.amazonaws.com/items.json"
modestring

Ações de importação:

Padrão "create_and_update"
Enum ValorDescrição
create

Adicionar novos itens.

create_and_update

Adicionar novos itens e atualizar os existentes.

sync

Adicionar novos, atualizar os existentes e desativar itens ausentes.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v1/projects/44056/import/from_external_file \
  -H 'Content-Type: application/json' \
  -d '{
    "connector_external_id": "import_items",
    "file_url": "https://my-bucket.s3.amazonaws.com/items.json",
    "mode": "create"
  }'

Respostas

O arquivo foi importado com sucesso e será processado agora.

Corpoapplication/json
import_idstring

ID da operação de importação. Se você encontrar dificuldades para importar o arquivo JSON, informe essa ID ao seu Gerente de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com.

Exemplo: "af9f3638a16e11ef880da2cd677d2d24"
Resposta
application/json
{
  "import_id": "af9f3638a16e11ef880da2cd677d2d24"
}