Criar moeda virtual

Criar moeda virtualServer-sideAdmin

post/v2/project/{project_id}/admin/items/virtual_currency

Cria uma moeda virtual.

Request

path Parameters

project_id

required

integer

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Example: 44056

Request Body schema: application/json

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.

required

object

Objeto com traduções para o nome do item. Código de idioma de duas letras minúsculas.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

Array of objects <= 20 items

Lista de atributos.

Atenção. Não é possível especificar mais de 20 atributos para o item. Qualquer tentativa de exceder o limite resulta em um erro.

Array (<= 20 items)

external_id

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

ID de atributo exclusivo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

required

Array of objects

Atenção. Não é possível criar mais de 6 valores para cada atributo. Qualquer tentativa de exceder o limite resulta em um erro.

Array

required

object

Default: {"de":"Strategie","en":"Strategy"}

Objeto com traduções do nome do valor. As chaves são especificadas no formato ISO 3166-1.

property name*

additional property

string

external_id

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

object

Default: {"de":"Genre","en":"Genre"}

Objeto com localizações para o nome do atributo. As chaves são especificadas no formato ISO 3166-1.

property name*

additional property

string

custom_attributes

object <json> <= 500 characters

Um objeto JSON que contém atributos e valores de item. Os atributos permitem que você adicione mais informações a itens como o nível necessário do jogador para usar o item. Os atributos enriquecem a lógica interna do seu jogo e são acessíveis através de métodos GET e webhooks dedicados.

object

Objeto com localizações para descrição do item. Duas letras minúsculas código de idioma.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

Array of objects

Default: []

Grupo aos quais o item pertence.

Array

external_id

string

object

Default: {"en":"Horror"}

Nome do item. Deve conter pares chave/valor onde chave é uma localização com o formato "^[a-z]{2}", e o valor é uma cadeia de caracteres.

additionalProperties

string

image_url

string

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

Se true, o item é gratuito.

is_hard

boolean

is_show_in_store

boolean

object

Limites de itens.

per_item

integer or null

Limitação global de itens.

per_user

integer or null

Limitação de item para um usuário separado.

object or null

Limite o período de atualização.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)

One of:

Tipo diário de atualização de limites de usuário.

interval_type required	string Período de atualização recorrente. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).

object

Objeto com traduções para a descrição longa do item. Duas letras minúsculas código de idioma.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

Array of objects

Recursos adicionais do item, como capturas de tela, vídeos de jogabilidade e assim por diante.

Array

type	string Tipo de mídia: `image`/`video`. Enum: "image" "video"
url	string Arquivo de recurso.

order

integer

Define a ordem do arranjo.

Array of objects or null

Período de venda de itens.

Array

date_from	string <date-time> Data em que o item especificado estará disponível para venda.
date_until	string or null <date-time> Data em que o item especificado ficará indisponível para venda. Pode ser `null`.

object

release_date required	string or null <date-time>
is_enabled required	boolean
description	string or null

Array of objects

Array

amount required	number > 0 Quantidade.
currency required	string Moeda do preço do item. Código de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.
country_iso	string or null País onde este preço está disponível. Código de duas letras de acordo com o padrão ISO 3166-1 alpha 2.
is_default	boolean Default: false
is_enabled	boolean Default: true

Array of objects

Array

id	integer >= 1

Array of objects

Array

amount required	integer
is_default required	boolean Default: false
is_enabled required	boolean Default: false O preço está habilitado.
sku	string ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.

Responses

201

Item virtual criado com sucesso.

422

Solicitação inválida.

Request samples

application/json

{"attributes": [{"external_id": "material",
"name": {"en-US": "Material"
},
"values": [{"external_id": "gold",
"value": {"en-US": "Gold"
}
}
]
}
],
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"de-DE": "Die Hauptwährung deines Königreichs",
"en-US": "The main currency of your kingdom"
},
"groups": ["gold"
],
"is_enabled": true,
"is_free": false,
"limits": {"per_item": 10000,
"per_user": 5
},
"name": {"de-DE": "Goldmünze",
"en-US": "Gold coin"
},
"order": 1,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [{"amount": 100,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"sku": "coin"
}

Response samples

application/json

{"sku": "new-sku"
}