Atualização automática de catálogo via API

Você pode automatizar a criação e atualização do catálogo com as chamadas In-Game Store API. Com a automação, você pode manter seu catálogo atualizado sem gastar muito tempo com ele. A automação de catálogos permite criar e atualizar itens e promoções e importar dados de sistemas externos.

Isso reduz o tempo necessário para manter e atualizar:

• catálogos que contêm muitos itens
• promoções de qualquer tipo
• preços baseados no país

A autorização básica é usada para chamadas de API para criar e atualizar itens e promoções. Passe o Authorization:Basic <your_authorization_basic_key>, onde <your_authorization_basic_key> é o par merchant ID:API key codificado de acordo com o padrão Base64. Vá para a Conta de Distribuidor para encontrar estes parâmetros:

• O Merchant ID é exibido:
  • Na seção Company settings > Company.
  • No URL na barra de endereços do navegador em qualquer página da Conta de Distribuidor. O URL tem o seguinte formato: https:​//publisher.xsolla.com/<merchant ID>/<Publisher Account section>.

• A API key é mostrada na Conta de Distribuidor apenas uma vez, durante a criação, e deve ser armazenada por você. Você pode criar uma nova chave na seguinte seção:
  • Company settings > API keys
  • Project settings > API keys

Criar e atualizar itens

Se você precisar criar diversos itens, você pode criar um script que chama o método API do tipo de item necessário diversas vezes.

Itens virtuais

Para atualizar o catálogo:

1. Obtenha dados do catálogo com os métodos de API Get virtual item ou Get all virtual items list.
2. Passe novos valores de parâmetro com o método de API Update virtual item.

Para criar itens virtuais, use o método de API Create virtual currency.

Conjuntos

Para atualizar o catálogo:

1. Obtenha dados do catálogo com o método de API Obter lista de pacotes.
2. Passe novos valores de parâmetro com o método de API Conjunto de atualização.

Para criar um pacote, use o método de API Criar conjunto.
Se você quiser adicionar chaves de jogo, restrições de país ou preços aos conjuntos, use as instruções.

Crie e atualize promoções

Cupons

Para atualizar a promoção:

1. Obtenha dados do catálogo com os métodos de API Get cupon promotion ou Get list of cupon promotions.
2. Passe novos valores de parâmetro com o método de API Update cupon promotion.
3. Ative a promoção com o método de API Activate cupon promotion.

Para criar uma promoção, use os métodos de API Create coupon promotion e, em seguida, Create coupon code para criar códigos de cupons personalizados ou Generate coupon codes para gerar códigos de cupom aleatórios.
Para desativar uma promoção, use o método de API Deactivate coupon promotion.

Códigos promocionais

Para atualizar a promoção:

1. Obtenha dados do catálogo com os métodos de API Get promo codes promotion ou Get list of promo codes promotions.
2. Passe novos valores de parâmetro com o método de API Update promo codes promotion.
3. Ative a promoção com o método de API Activate promo code promotion.

Para criar uma promoção, use os métodos de API Create promo code promotion e, em seguida, Create code for promo code promotion para criar códigos promocionais personalizados ou Generate codes for promo code promotion para gerar códigos promocionais aleatórios.
Para desativar uma promoção, use o método de API Deactivate promo code promotion.

Descontos

Para atualizar a promoção:

1. Obtenha dados do catálogo com os métodos de API Get item promotion ou Get list of bonus promotions.
2. Passe novos valores de parâmetro com o método de API Update item promotion.
3. Ative a promoção com o método de API Activate promotion.

Para criar uma promoção, use o método de API Create discount promotion for item.
Para desativar uma promoção, use o método de API Deactivate promotion.

Bônus

Para atualizar a promoção:

1. Obtenha dados do catálogo com os métodos de API Get bonus promotion ou Get list of bonus promotions.
2. Passe novos valores de parâmetro com o método de API Update bonus promotion.
3. Ative a promoção com o método de API Activate promotion.

Para criar uma promoção, use o método de API Create bonus promotion.
Para desativar uma promoção, use o método de API Deactivate promotion.

Criação automática de itens via API

Se você precisa criar diversos itens com base nos dados do seu sistema, você pode automatizar esse processo usando a API.

Você precisa:

• Exportar os dados do item do seu sistema.
• Transformar os dados exportados em um formato que corresponda ao método API do tipo de item necessário.
• Crie um script que chama o método API necessário para cada item na exportação:
  • Create virtual item
  • Create virtual currency
  • Create virtual currency package
  • Criar conjunto

Se você quiser usar grupos de itens, crie-os antecipadamente pela interface da Conta de Distribuidor.

Se quiser usar múltiplos tipos de itens, eles devem ser criados na seguinte ordem:

1. grupos de itens na Conta de Distribuidor.
2. Moedas virtuais.
3. Itens virtuais.
4. Pacotes de moedas virtuais.
5. Conjuntos.

A seguir está um exemplo de um script que chama repetidamente o método Create virtual item para criar itens virtuais.

O script é desenvolvido usando JavaScript e o tempo de execução do JavaScript — Node.js.

1. Importe a função fetch do módulo “node-fetch” para enviar solicitações ao servidor Xsolla.

import fetch from "node-fetch";

2. Defina as constantes necessárias para solicitar a autorização. Em vez de <your project_id from PA> e <your api key from PA>, insira seus valores no ID de projeto e chave API, que será codificado usando Base64 para o uso subsequente nas solicitações API.

const projectId = <your project_id from PA>;

const apiKey = <your api key from PA>;

const buff = new Buffer(`${projectId}:${apiKey}`);

const basicAuth = buff.toString('base64')

3. Implemente a função do ajudante sleep, que é usada para criar um atraso ao enviar solicitações. isso é necessário para não exceder os limites de taxa de solicitações API.

function sleep(ms) {

   return new Promise(resolve => setTimeout(resolve, ms));

}

4. Implemente a função getItems, que é específica ao seu sistema, para receber dados de itens do seu sistema.

async function getItems() {

   // receive items from the original system or read from a pre-prepared file

   return items;

}

5. Implemente a função prepareData, que é específica ao seu sistema, para formatar os dados do item de acordo com o formato de dados na chamada de API Create virtual item.

function prepareData(items) {

   // format items in accordance with API requirements

   return formattedItems;

}

6. Adicione a função createItem, que envia uma solicitação POST à API Xsolla para criar um item virtual.

async function createItem(item) {

   const url = `https://store.xsolla.com/api/v2/project/${projectId}/admin/items/virtual_items`;



   return await fetch(url, {

       method: "POST",

       headers: {

           Authorization: "Basic " + basicAuth,

           "Content-Type": "application/json"

       },

       body: JSON.stringify(item),

   });

}

7. Adicione a função checkItemExist, que verifica se um item virtual com um SKU especificado existe. A função envia uma solicitação GET à API Xsolla:
   • Se uma resposta com um código HTTP 404 for recebida, o item com o SKU especificado não foi encontrado, e precisa ser criado.
   • Se uma resposta com um código HTTP 200 for recebido, o item com o SKU especificado foi encontrado e não precisa ser criado.

async function checkItemExist(sku) {

   const url = `https://store.xsolla.com/api/v2/project/${projectId}/admin/items/virtual_items/sku/${sku}`;

   const response = await fetch(url, {

       method: "GET",

       headers: {

           Authorization: "Basic " + basicAuth

       }

   });

   return response.status !== 404;

}

8. Adicione a função createItems, que passa pela lista de itens e verifica se há um item com um SKU do seu sistema no lado Xsolla. Se não houver um item com esse SKU, a função o cria. A informação de progresso é exibida no console.

async function createItems(items) {

   let success = 0;

   let alreadyCreated = 0;

   for (let i = 0; i < items.length; i++) {

       const item = items[i];

       if (item['sku'] === undefined) {

           console.log(`${i} Field "sku" not specified`);

           continue;

       }

       const sku = item['sku'];

       if (await checkItemExist(sku)) {

           console.log(`${i} Item with sku "${sku}" already created`);

           alreadyCreated++;

           continue;

       }

       const response = await createItem(item);

       if (response.status === 201) {

           console.log(`${i} Item with sku "${sku}" successfully created`)

           success++;

       } else {

           const jsonData = await response.json();

           console.log(`${i} An error occurred while creating the items with sku "${sku}"`);

           console.log(jsonData);

       }

       // add a delay so as not to run into rate limits

       await sleep(500);

   }

   console.log(`${success} items out of ${items.length} created. ${alreadyCreated} items already existed`);

}

9. Adicione a função run que chama todas as funções na ordem correta.

async function run() {

 const items = await getItems();

 const formattedItems = prepareData(items);

 await createItems(formattedItems);

}

O código completo:

import fetch from "node-fetch";

const projectId = <your project_id from PA>;
const apiKey = <your api key from PA>;
const buff = new Buffer(`${projectId}:${apiKey}`);
const basicAuth = buff.toString('base64')

function sleep(ms) {
    return new Promise(resolve => setTimeout(resolve, ms));
}

async function getItems() {
    // receive items from the original system or read from a pre-prepared file
    return items;
}

function prepareData(items) {
    // format items in accordance with API requirements
    return formatedItems;
}

async function createItem(item) {
    const url = `https://store.xsolla.com/api/v2/project/${projectId}/admin/items/virtual_items`;

    return await fetch(url, {
        method: "POST",
        headers: {
            Authorization: "Basic " + basicAuth,
            "Content-Type": "application/json"
        },
        body: JSON.stringify(item),
    });
}

async function isItemExisted(sku) {
    const url = `https://store.xsolla.com/api/v2/project/${projectId}/admin/items/virtual_items/sku/${sku}`;
    const response = await fetch(url, {
        method: "GET",
        headers: {
            Authorization: "Basic " + basicAuth
        }
    });
    return response.status !== 404;
}

async function createItems(items) {
    let success = 0;
    let alreadyCreated = 0;
    for (let i = 0; i < items.length; i++) {
        const item = items[i];
        if (item['sku'] === undefined) {
            console.log(`${i} Field "sku" not specified`);
            continue;
        }
        const sku = item['sku'];
        if (await isItemExisted(sku)) {
            console.log(`${i} Item with sku "${sku}" already created`);
            alreadyCreated++;
            continue;
        }
        const response = await createItem(item);
        if (response.status === 201) {
            console.log(`${i} Item with sku "${sku}" successfully created`)
            success++;
        } else {
            const jsonData = await response.json();
            console.log(`${i} An error occurred while creating the items with sku "${sku}"`);
            console.log(jsonData);
        }
        // add a delay so as not to run into rate limits
        await sleep(500);
    }
    console.log(`${success} items out of ${items.length} created. ${alreadyCreated} items already existed`);
}

async function run() {
  const items = await getItems();
  const formattedItems = prepareData(items);
  await createItems(formattedItems);
}

run(); 

Atualização por importação de sistemas externos