Actualización automática del catálogo mediante API

Puede automatizar la creación y actualización del catálogo con las llamadas API In-Game Store. Con la automatización, puede mantener su catálogo actualizado sin invertir mucho tiempo. La automatización del catálogo le permite crear y actualizar artículos y promociones e importar datos de sistemas externos.

Esto reduce el tiempo necesario para mantener y actualizar:

• catálogos que contienen muchos artículos
• promociones de cualquier tipo
• precios en función del país

La autorización básica se utiliza para las llamadas API. Introduzca la Authorization:Basic <your_authorization_basic_key>, en la cual <your_authorization_basic_key> es el par Merchant ID:clave de API codificado según el estándar Base64. Vaya a Cuenta del editor para encontrar estos parámetros:

• Merchant ID se muestra:
  • en la sección Company settings > Company.
  • En la URL de la barra de direcciones del navegador de cualquier página de Cuenta del editor. La URL tiene el siguiente formato: https:​//publisher.xsolla.com/<merchant ID>/<Publisher Account section>.

• Clave de API se muestra en la Cuenta del editor solo una vez cuando se crea y debe almacenarse en su servidor. Puede crear una nueva clave en la siguiente sección:
  • Company settings > API keys
  • Project settings > API keys

Crear y actualizar artículos

Si necesita crear varios artículos, puede crear un script que invoque el método API del tipo de artículo requerido el número de veces que sea necesario.

Artículos virtuales

Para actualizar el catálogo:

1. Obtenga datos del catálogo con el método de API Obtener artículo virtual o Obtener la lista de todos los artículos virtuales.
2. Transmita los nuevos valores del parámetro con el método de API Actualizar artículo virtual.

Para crear artículos virtuales, utilice el método de API Crear artículo virtual.

Lotes

Para actualizar el catálogo:

1. Obtenga datos del catálogo con el método de API Obtener lista de lotes.
2. Transmita los nuevos valores de los parámetros con el método de API Actualizar lote.

Para crear un lote, utilice el método de API Crear lote.
Si desea agregar claves del juego, restricciones por países o precios a los lotes, utilice las instrucciones.

Crear y actualizar promociones

Cupones

Para actualizar la promoción:

1. Obtenga datos del catálogo con los métodos de API Obtener cupón promocional o Obtener la lista de promociones con cupones.
2. Transmita los nuevos valores de los parámetros con el método de API Actualizar promoción con cupones.
3. Active la promoción con el método de API Activar promoción con cupones.

Para crear una promoción, utilice los métodos de API Crear promoción con cupones y, a continuación, Crear código de cupón para crear códigos de cupón personalizados o Generar códigos de cupón para generar códigos de cupón aleatorios.
Para desactivar una promoción, utilice el método de API Desactivar promoción con cupones.

Códigos promocionales

Para actualizar la promoción:

1. Obtenga datos del catálogo con los métodos de API Obtener la lista de promociones de códigos promocionales o Obtener la lista de promociones de códigos promocionales.
2. Transmita los nuevos valores de los parámetros con el método de API Actualizar promoción de códigos promocionales.
3. Active la promoción con el método de API Activar promoción.

Para crear una promoción, utilice los métodos de API Crear promoción de códigos promocionales y, luego, Crear código de promoción de códigos promocionales para crear códigos promocionales personalizados o Generar códigos para una promoción de códigos promocionales para generar códigos promocionales aleatorios.
Para desactivar una promoción, utilice el método de API Desactivar promoción de códigos promocionales.

Descuentos

Para actualizar la promoción:

1. Obtenga datos del catálogo con los métodos de API Obtener promoción del artículo o Obtener lista de promociones del artículo.
2. Transmita los nuevos valores de los parámetros con el método de API Actualizar la promoción del artículo.
3. Active la promoción con el método de API Activar promoción.

Para crear una promoción, use el método de API Crear promoción de descuento para un artículo.
Para desactivar una promoción, utilice el método de API Desactivar promoción.

Bonificaciones

Para actualizar la promoción:

1. Obtenga datos del catálogo con los métodos de API Obtener una promoción de bonificación o Obtenga la lista de promociones de bonificación.
2. Transmita los nuevos valores de los parámetros con el método de API Actualizar la promoción de bonificación.
3. Active la promoción con el método de API Activar promoción.

Para crear una promoción, use el método de API Crear promoción de bonificación.
Para desactivar una promoción, utilice el método de API Desactivar promoción.

Creación automática de artículos mediante API

Si tiene que crear numerosos artículos a partir de los datos de su sistema, puede automatizar este proceso mediante la API.

Tendrá que:

• Exportar los datos del artículo desde su sistema.
• Transformar los datos exportados a un formato que coincida con el formato de datos del método API del tipo de artículo requerido.
• Para cada artículo de la exportación, cree un script que invoque el método API requerido:
  • Crear artículo virtual
  • Crear moneda virtual
  • Crear un paquete de moneda virtualpackage
  • Crear lote

Si quiere utilizar grupos de artículo, créelos antes en la interfaz de la Cuenta del editor.

Si pretende usar varios tipos de artículos, deben crearse en el siguiente orden:

1. Grupos de artículos en Cuenta del editor.
2. Monedas virtuales.
3. Artículos virtuales.
4. Paquetes de moneda virtual.
5. Lotes.

A continuación, presentamos un ejemplo de script que invoca repetidamente el método Crear artículo virtual para crear artículos virtuales.

El script se desarrolla utilizando JavaScript y el tiempo de ejecución de JavaScript: Node.js.

1. Importe la función fetch del módulo “node-fetch” para enviar solicitudes HTTP al servidor de Xsolla.

import fetch from "node-fetch";

2. Establezca las constantes necesarias para la autorización de la solicitud. En lugar de <your project_id from PA> y <your api key from PA>, ingrese sus valores para el ID del proyecto y la clave de API, que se codificarán usando Base64 para su posterior uso en las solicitudes a la 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 la función de ayuda sleep, la cual se usa para crear un retardo al enviar solicitudes. Esto es imprescindible para no exceder los límites de frecuencia de la solicitud a la API.

function sleep(ms) {

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

}

4. Implemente la función getItems, específica de su sistema, para recuperar los datos de los artículos desde su sistema.

async function getItems() {

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

   return items;

}

5. Implemente la función prepareData, específica de su sistema, para dar formato a los datos del artículo según el formato de datos definido en la llamada API Crear artículo virtual.

function prepareData(items) {

   // format items in accordance with API requirements

   return formattedItems;

}

6. Agregue la función createItem, la cual envía una solicitud POST a la API de Xsolla para crear un artículo 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. Agregue la función checkItemExist, la cual comprueba si existe un artículo virtual con un código de artículo (SKU) especificado. La función envía una solicitud GET a la API de Xsolla:
   • Si se recibe una respuesta con un código HTTP 404, el artículo con el SKU especificado no se localiza y hay que crearlo.
   • Si se recibe una respuesta con un código HTTP 200, el artículo con el SKU especificado se localiza y no hay que crearlo.

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. Agregue la función createItems, la cual analiza la lista de artículos y comprueba si existe un artículo con un código de artículo (SKU) de su sistema en el lado de Xsolla. Si no hay ningún artículo con ese SKU, la función lo crea. La información del progreso se visualiza en la consola.

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. Agregue la función run que invoca todas las funciones anteriores en el orden correcto.

async function run() {

 const items = await getItems();

 const formattedItems = prepareData(items);

 await createItems(formattedItems);

}

El 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(); 

Actualizar mediante importación desde sistemas externos