Adicionar novos itens.
Catalog API (2.0.0)
- 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.
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/
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- https://connector.xsolla.com/v1/admin/projects/{project_id}/connectors/import_items/import/status
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v1/admin/projects/{project_id}/connectors/import_items/import/status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://connector.xsolla.com/v1/admin/projects/44056/connectors/import_items/import/statusO status da importação foi recuperado com êxito.
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"
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"
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"
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}
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" }
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
Corpoapplication/jsonID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Um valor fixo que especifica o tipo de operação para importar itens.
Valor"import_items"
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"
- https://connector.xsolla.com/v1/projects/{project_id}/import/from_external_file
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v1/projects/{project_id}/import/from_external_file
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://connector.xsolla.com/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"
}'Resposta
application/json
{ "import_id": "af9f3638a16e11ef880da2cd677d2d24" }