Códigos de erro

Todo erro tem um código estável. Os SDKs usam os mesmos códigos (no Unity, como enum), além de alguns para problemas que acontecem antes de a requisição chegar ao servidor.

Comentários de código e nomes da API ficam em inglês para corresponder aos SDKs.

Nesta página

Erros da API
Erros exclusivos dos SDKs
Tratamento de erros

Erros da API#

Código	HTTP	Unity	Quando	Repetir?
`validation`	400, 422	`Validation`	Entrada inválida; `details.fields` indica o campo.	Não
`unauthorized`	401	`Unauthorized`	Chaves erradas ou token de jogador ausente, expirado ou revogado.	Não
`forbidden`	403	`Forbidden`	Projeto suspenso, endpoint exclusivo de servidor ou HTTPS obrigatório.	Não
`plan_limit`	403	`PlanLimit`	Um limite do plano foi atingido (jogadores, entradas, armazenamento…). Nada é excluído.	Não
`not_found`	404	`NotFound`	Endpoint, placar, jogador ou chave de salvamento desconhecido.	Não
`conflict`	409	`Conflict`	Ação já realizada, ex.: uma recompensa já resgatada neste período.	Não
`revision_mismatch`	409	`RevisionMismatch`	Um salvamento na nuvem foi alterado em outro dispositivo.	Não
`rate_limited`	429	`RateLimited`	Requisições demais por minuto ou intervalo entre envios de um placar. Aguarde `Retry-After` segundos.	Sim
`quota_exceeded`	429	`QuotaExceeded`	A cota diária de requisições da conta acabou; ela reinicia às 00:00 UTC.	Não
`server_error`	500	`ServerError`	Algo falhou no servidor. Os SDKs repetem as requisições seguras.	Sim

Erros exclusivos dos SDKs#

Código	HTTP	Unity	Quando	Repetir?
`network`	—	`Network`	Não foi possível alcançar o servidor.	Sim
`timeout`	—	`Timeout`	A requisição demorou mais do que o tempo limite.	Sim
`not_configured`	—	`NotConfigured`	URL base, ID do projeto ou chave de cliente ausente ou inválido.	Não
`not_signed_in`	—	`NotSignedIn`	Uma chamada de jogador antes do login ou depois que a sessão expirou.	Não
`signature_invalid`	—	`SignatureInvalid`	A configuração remota falhou na verificação e não foi usada.	Não
`parse_error`	—	`ParseError`	Não foi possível ler a resposta (geralmente um proxy ou uma página de erro em HTML).	Não
`link_expired`	—	`LinkExpired`	A página de vinculação de conta expirou; comece de novo.	Não
`link_cancelled`	—	`LinkCancelled`	O fluxo de vinculação de conta foi cancelado.	Não

Tratamento de erros#

Mostre message para desenvolvedores, não para jogadores; tome decisões com base no código. Repita apenas os erros que permitem nova tentativa e registre o ID da requisição para encontrá-la na página Logs.

var top = await Majacloud.Leaderboards.GetTopAsync("coins", 10);
if (top.Ok)
{
    foreach (var entry in top.Value.Entries)
        Debug.Log($"#{entry.Rank} {entry.PlayerName} {entry.Score}");
}
else if (top.Error.IsRetryable)
{
    // Network, timeout, 5xx or rate limit: try again later
    Debug.Log("Retry in " + top.Error.RetryAfterSeconds + " s");
}
else
{
    Debug.LogWarning(top.Error.Code + ": " + top.Error.Message + " (" + top.Error.RequestId + ")");
}

GDScript

var top := await Majacloud.leaderboards.get_top("coins", 10)
if top.ok:
	for entry in top.value.entries:
		print("#%d %s %d" % [entry.rank, entry.player_name, entry.score])
elif top.is_retryable():
	# Network, timeout, 5xx or rate limit: try again later
	print("Retry in ", top.retry_after, " s")
else:
	push_warning("%s: %s (%s)" % [top.error, top.message, top.request_id])

JavaScript

const top = await mc.leaderboards.getTop('coins', { limit: 10 });
if (top.ok) {
  for (const entry of top.value.entries) {
    console.log(`#${entry.rank} ${entry.player_name} ${entry.score}`);
  }
} else if (top.error.retryable) {
  // Network, timeout, 5xx or rate limit: try again later
  console.log('Retry in', top.error.retryAfter, 's');
} else {
  console.warn(`${top.error.code}: ${top.error.message} (${top.error.requestId})`);
}

JSON

// Success
{ "ok": true, "entries": [ … ], "total": 42 }

// Error (HTTP 4xx/5xx)
{
  "ok": false,
  "error": {
    "code": "rate_limited",
    "message": "Project rate limit reached. Try again in a minute.",
    "request_id": "6f1c2a9e-…",
    "details": { "limit": 120, "window": "minute" }
  }
}