Pular para o conteúdo principal

Visão geral da API REST

Bem-vindo à referência da API REST do PlayFab. Aqui você encontrará material de referência e entenderá como nossas APIs funcionam. Cada referência de API é dividida em várias seções diferentes.

Ponto de extremidade

O ponto de extremidade é a URL HTTP na qual você pode fazer solicitações de API. Ele é precedido por um tipo de método REST (por exemplo, GET, POST). Além disso, o titleId deve ser substituído pelo titleId do seu jogo. Exemplo:

Corpo da solicitação

O corpo da solicitação é o modelo de objeto enviado (em JSON) ao nosso serviço de API. Esses modelos contêm propriedades que precisam ser enviadas junto com sua API como conteúdo. Algumas propriedades são sinalizadas como obrigatórias, enquanto outras são opcionais.

Respostas

O serviço de API retornará um 200 OK com um conteúdo JSON que pode ser desserializado como um modelo. No exemplo abaixo, as chamadas da API de login são desserializadas em um tipo LoginResult. Exemplo de resposta 200 OK com um LoginResult Se a resposta falhar, será recebida uma resposta de erro 4XX. Um 400 Bad Request geralmente pode ocorrer devido a parâmetros ausentes na sua chamada de API ou a outros motivos, como exceder limites de taxa e erros de validação. Se você encontrar um erro 4XX, é melhor verificar os parâmetros da solicitação e o token de autenticação e garantir que estejam corretos. O objeto ApiErrorWrapper contém informações valiosas sobre o erro, incluindo códigos de erro, detalhes do erro e mensagens de erro do servidor para ajudar a identificar o problema.

Segurança

Cada API tem alguma forma de segurança que precisa ser passada no cabeçalho de cada solicitação. Consulte esta seção para saber o que precisa ser definido. Às vezes, isso é um tíquete de sessão de uma solicitação de login, ou pode ser a chave secreta do seu título se você estiver fazendo solicitações de API de servidor.

Simultaneidade

O serviço de API foi projetado para lidar com um número muito grande de chamadas simultâneas de cada título, mas há limites e restrições quanto ao número de chamadas simultâneas que podem acessar um único jogador ou outra entidade única, como um personagem ou grupo. Se esse limite de simultaneidade for excedido, a API retornará um código de erro APIConcurrentRequestLimitExceeded ou ConcurrentEditError. Em geral, é seguro fazer mais de uma solicitação de leitura para um determinado jogador simultaneamente, mas é melhor fazer uma única solicitação de atualização por vez.

Definições de modelo

Cada resposta do serviço de API pode conter um ou mais modelos. Eles estão localizados abaixo do ApiErrorWrapper, e cada modelo é representado no mesmo documento que a API. Cada modelo também é vinculado no modelo pai da resposta. Você também pode visitar a seção Definições em cada página de API para ver uma lista dos modelos compatíveis com a API.

Definições de modelo de evento

A referência do Modelo de Eventos do PlayStream contém os modelos dos tipos de eventos do PlayStream gerados automaticamente. Cada tipo de evento tem um conjunto de propriedades que são incluídas como parte dos dados do evento onde quer que ele seja enviado.
Última modificação em 6 de outubro de 2026