API para clubes
Versão 1. O servidor do site do seu clube pode mostrar os torneios do clube e enviar inscrições de jogadores para o clube. Esta página lista cada chamada, campo e erro, e o que a API não faz.
Para que serve
Um clube de poker gerencia os torneios na LynxPoker. Com uma chave de API do clube, o próprio site do clube pode mostrar esses torneios e deixar os jogadores se inscreverem neles por lá.
Uma inscrição pelo site nunca senta o jogador e nunca cobra pagamento. Ela fica esperando na LynxPoker até a equipe do clube sentar o jogador ou recusar a inscrição.
Antes de começar
- Só o dono do clube pode criar uma chave, no app web da LynxPoker, em Configurações e depois Chaves de API. O dono escolhe um nome e o que a chave pode fazer. Um clube pode ter até 20 chaves ativas.
- Uma chave precisa de um plano. Um clube no teste grátis não pode criar uma. Qualquer plano vale, seja qual for a forma de pagamento, e também um plano que demos ao clube. Se o pagamento no cartão do clube falha, as chaves dele continuam funcionando enquanto o pagamento é tentado de novo. Quando a assinatura fica sem pagamento, ou o plano termina, toda chamada com as chaves dele é recusada com
403CLUB_API_NEEDS_PLAN. Guardamos as chaves, e elas voltam a funcionar na próxima chamada assim que o clube tiver um plano. - Mostramos uma chave só uma vez, quando ela é criada. Se ela se perder, o dono a revoga e cria uma nova. Uma chave revogada para de funcionar na hora e não pode ser reativada.
- Chame a API só do seu servidor. A chave é secreta: nunca a coloque numa página web, num app de celular ou num repositório de código público. Uma chamada que traz o cabeçalho
Originde um navegador no seu site é recusada com403CLUB_API_BROWSER_BLOCKED. Se o seu servidor repassa para nós a requisição de um visitante, não copie os cabeçalhos do navegador.
Chaves e respostas
Toda chamada vai para este endereço. Os caminhos desta página começam com /api.
https://api.lynx.pokerEnvie a chave no cabeçalho Authorization de toda chamada, depois da palavra ClubKey e um espaço:
Authorization: ClubKey <keyId>.<secret>Uma chave tem duas partes unidas por um ponto: o ID da chave e o segredo. Envie exatamente como você copiou.
O que uma chave pode fazer
O dono escolhe isso ao criar a chave. Uma chamada que precisa de um acesso que a chave não tem é recusada com 403.
| Acesso | Nome no app | Chamadas |
|---|---|---|
TOURNAMENTS_READ | Ler torneios | GET /api/club-api/v1/tournaments GET /api/club-api/v1/tournaments/:id |
REGISTRATIONS_CREATE | Enviar inscrições | POST /api/club-api/v1/tournaments/:id/registrations |
Respostas
Toda resposta é JSON. Uma resposta de sucesso traz os dados em body. O campo status dela sempre diz 200, então leia o status HTTP: 200 para uma leitura, 201 para uma inscrição.
Uma resposta de erro tem o status HTTP, uma message para pessoas e, na maioria dos erros, um errorCode. Leia o status HTTP e o errorCode, nunca a mensagem: as mensagens podem mudar.
HTTP/1.1 409 Conflict
{
"statusCode": 409,
"message": "Registration for this tournament is full.",
"errorCode": "APP_REG_CAP_FULL",
"details": { "limit": 40 },
"timestamp": "2026-11-10T09:30:00.000Z",
"path": "/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10/registrations"
}Chamadas
Listar os torneios do clube
GET/api/club-api/v1/tournaments
Acesso necessário: TOURNAMENTS_READ
Devolve os torneios rodando ou pausados agora, depois os que ainda não começaram e estão marcados para os próximos 30 dias. Um torneio que não começou fica na lista por 6 horas depois do início marcado. A lista tem no máximo 200: os ao vivo primeiro, depois pelo início marcado. Um torneio que ainda não começou só entra na lista quando tem um início marcado. Torneios encerrados nunca entram na lista: leia um pelo ID dele.
Torneios ocultos para os jogadores e o torneio de treino do clube nunca aparecem na lista.
Cada item é o resumo que o app dos jogadores da LynxPoker mostra: o buy-in, o início, quando a inscrição tardia fecha, e o tamanho do field e o prize pool quando o clube os mostra. serverTime é o nosso relógio, para você corrigir o seu.
curl https://api.lynx.poker/api/club-api/v1/tournaments \
-H "Authorization: ClubKey $LYNX_CLUB_KEY"{
"status": 200,
"body": {
"items": [
{
"id": "b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10",
"organizationId": "5c2e9a71-0d3b-4f6a-8e14-2b7c9d0a1f33",
"timeFormat": "24h",
"dateFormat": "dmy",
"title": "Thursday deepstack",
"description": null,
"game": "Holdem",
"type": "Regular",
"format": "ReEntry",
"scheduledStartAt": "2026-11-12T18:00:00.000Z",
"startingTime": null,
"gameStatus": {
"position": "Created",
"currentLevelUuid": null,
"currentLevelStartTimestamp": null,
"unTouchedCurrentLevelStartTimestamp": null,
"currentLevelPauseStartTimestamp": null,
"startTimestamp": null,
"endTimestamp": null,
"tables": []
},
"settings": {
"buyIn": 800,
"rake": 150,
"bounty": null,
"startingStack": 30000,
"guarantee": 10000,
"reEntryLimit": 2,
"format": "ReEntry",
"isDisplayPrizes": true,
"isDisplayPotLimitBetRange": true,
"showReEntries": true,
"showTotalChips": true,
"showAddOns": false,
"showSeats": true,
"isAnnouncement": false,
"announcement": "",
"color": null
},
"info": {
"activePlayers": 0,
"aggregateEntries": 0,
"aggregateReEntries": 0,
"totalPrizePool": 0
},
"levelDurationMinutes": 20,
"lateRegLevel": 8,
"lateRegCloseAt": "2026-11-12T20:40:00.000Z",
"lateRegClosed": false
}
],
"serverTime": "2026-11-10T09:30:00.000Z"
}
}Erros que esta chamada pode devolver: 401, 403, 429, 500, 503
Ver um torneio
GET/api/club-api/v1/tournaments/:id
Acesso necessário: TOURNAMENTS_READ
Devolve um torneio do seu clube, em qualquer estado, mesmo depois que ele termina. Tem todos os campos de um item da lista, mais os níveis de blinds, os prêmios e os jogadores quando o clube mostra os nomes. Segue as configurações do clube para o app dos jogadores, então mostra só o que os jogadores veem.
lateRegClosed é true quando as inscrições estão fechadas: uma inscrição então responde 409 APP_REG_CLOSED. appRegistrationEnabled é false quando o app dos jogadores não aceita inscrições para este torneio. Pode ser uma escolha do clube só para o app dos jogadores, ou as inscrições desligadas para este torneio, o que recusa as suas inscrições também com 403 APP_REG_DISABLED. appRegistrationLimit é o máximo de inscrições que o torneio aceita, do app dos jogadores e do seu site juntos, e null quer dizer sem limite. Nenhum campo garante que uma inscrição vai passar: quem decide é a resposta à inscrição.
curl https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10 \
-H "Authorization: ClubKey $LYNX_CLUB_KEY"{
"status": 200,
"body": {
"id": "b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10",
"title": "Thursday deepstack",
"levels": [
{
"uuid": "0f4b2a6c-1e3d-4b5a-9c7e-2d8f6a4b1c3e",
"order": 1,
"orderWithBreaks": 1,
"in": 100,
"out": 200,
"ante": 200,
"lengthInMinuets": 20,
"isBreak": false
}
],
"prizes": [],
"lastUpdatedAt": "2026-11-09T16:12:44.000Z",
"serverTime": "2026-11-10T09:30:00.000Z",
"appRegistrationEnabled": true,
"appRegistrationLimit": 40
}
}Resumida: a resposta real também tem todos os campos de um item da lista. <fields>Campos da resposta</fields> lista todos os campos.
Erros que esta chamada pode devolver: 401, 403, 404, 429, 500, 503
Enviar uma inscrição
POST/api/club-api/v1/tournaments/:id/registrations
Acesso necessário: REGISTRATIONS_CREATE
Pede para inscrever um jogador em um torneio. Envie o ID do jogador na lista de jogadores do clube, ou o nome do jogador com um telefone, um e-mail ou os dois. Nunca as duas formas na mesma chamada.
| Campo | Tipo | Obrigatório | Regras |
|---|---|---|---|
playerId | string | Envie este, ou name | O ID de um jogador da lista de jogadores do seu clube. No máximo 64 caracteres. |
name | string | Sim, sem playerId | O nome do jogador. Não pode ficar em branco, no máximo 120 caracteres. |
phone | string | Um telefone, um e-mail ou os dois, sem playerId | No máximo 32 caracteres. Veja as regras de telefone abaixo. |
email | string | Um telefone, um e-mail ou os dois, sem playerId | Um endereço de e-mail válido, no máximo 254 caracteres. |
Envie só estes campos: qualquer outro campo é recusado com 400. Um campo enviado como null conta como não enviado.
curl -X POST https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10/registrations \
-H "Authorization: ClubKey $LYNX_CLUB_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Jordan Example", "phone": "+1 702 555 0147", "email": "[email protected]"}'curl -X POST https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10/registrations \
-H "Authorization: ClubKey $LYNX_CLUB_KEY" \
-H "Content-Type: application/json" \
-d '{"playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e"}'A resposta é 201 com a inscrição. O status dela é sempre PENDING. createdPlayer é true quando esta chamada adicionou o jogador à lista de jogadores do clube.
HTTP/1.1 201 Created
{
"status": 200,
"body": {
"registrationId": "7d0c2f4e-8b1a-4e5f-a3c6-91b2d4e6f8a0",
"status": "PENDING",
"playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e",
"createdPlayer": true
}
}Erros que esta chamada pode devolver: 400, 401, 403, 404, 409, 413, 429, 500, 503
Como achamos o jogador
Com playerId, usamos esse jogador. Ele precisa estar na lista de jogadores do seu clube, senão a resposta é 404.
Com um nome, procuramos entre os jogadores do seu clube o mesmo número de telefone ou o mesmo e-mail. Um e-mail combina sem importar maiúsculas e minúsculas. O nome nunca é usado para achar alguém.
Se vários jogadores combinam, pegamos o que tem o mesmo telefone e o mesmo e-mail, depois o mesmo telefone, depois o mesmo e-mail. Entre iguais, pegamos o que a equipe atualizou por último.
Se achamos o jogador, usamos ele e não mudamos nada nos dados dele. Se não, adicionamos um novo jogador à lista de jogadores do clube com o nome, o telefone e o e-mail que você enviou.
Um número de telefone sem + é lido como um número do país do clube, ou de Israel quando o clube não tem país definido. Para um número de outro país, comece com + e o código do país. Um número inválido é recusado com 400.
Um número de mentira, cujos últimos 7 dígitos são todos iguais, como 050-0000000, é recusado com 400, a não ser que você envie também um e-mail. Aí achamos o jogador pelo e-mail.
Enviar a mesma inscrição de novo enquanto ela espera devolve a mesma inscrição, com o mesmo registrationId, e não muda nada. Então você pode repetir com segurança uma chamada que não respondeu a tempo. Isso só vale enquanto as inscrições estão abertas: depois que fecham, uma repetição responde 409 APP_REG_CLOSED, e depois que as inscrições do torneio são desligadas, 403 APP_REG_DISABLED.
O que acontece depois
A inscrição aparece na lista Jogadores inscritos do torneio na LynxPoker, marcada Pelo site, e a equipe recebe o mesmo alerta de uma inscrição pelo app dos jogadores. No caixa, a equipe senta o jogador ou recusa a inscrição.
A API não consegue dizer ao seu site o que a equipe decidiu. Nenhuma chamada lê uma inscrição, e não enviamos webhooks. Se o jogador usa o app dos jogadores da LynxPoker e está conectado ao clube, o app avisa quando ele é sentado.
Repetir a chamada não serve para conferir. Depois que o jogador é sentado ou entra na lista de espera, uma repetição responde 409 APP_REG_ALREADY_ENTERED. Depois que a equipe recusa uma inscrição, ou depois que o jogador é eliminado ou removido, uma repetição envia uma inscrição nova.
Campos da resposta
Todos os campos que as nossas respostas podem trazer, tirados da própria definição da API. O significado de um campo aparece quando o nome dele não diz.
Os horários são texto em UTC, como 2026-11-12T18:00:00.000Z. Um campo cujo nome termina em Timestamp é um número de milissegundos desde 1º de janeiro de 1970, em UTC. Valores em dinheiro são números simples, sem moeda.
Um campo marcado "quando se aplica" fica fora da resposta quando não se aplica. null só aparece num campo cujo tipo o inclui.
list
A resposta da chamada da lista.
Onde fica na resposta: body
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
items | tournament[] | Sempre | |
serverTime | string (date-time) | Sempre | O nosso relógio quando respondemos, para você corrigir o seu. |
tournament
Um torneio: cada item da lista, e o começo da resposta de detalhe.
Onde fica na resposta: body.items[] · body
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
id | string | Sempre | O ID do torneio, para as chamadas de detalhe e de inscrição. |
organizationId | string | Sempre | O ID do seu clube. |
timeFormat | "12h" | "24h" | Sempre | Como o clube escreve os horários: relógio de 12 ou de 24 horas. |
dateFormat | "dmy" | "mdy" | Sempre | Como o clube escreve as datas: dia primeiro (dmy) ou mês primeiro (mdy). |
title | string | Sempre | |
description | string | null | Sempre | |
game | "Holdem" | "Omaha" | Sempre | |
type | "Regular" | "Mystery" | "Bounty" | "Progressive" | "Satellite" | Sempre | |
format | "ReEntry" | "Freezeout" | "Rebuy" | Sempre | |
scheduledStartAt | string (date-time) | null | Sempre | O início marcado. null quando o jogo começa. |
startingTime | string (date-time) | null | Sempre | Quando o jogo começou. null antes disso. |
gameStatus | gameStatus | Sempre | |
settings | settings | Sempre | |
info | info | Sempre | |
levelDurationMinutes | number | null | Sempre | A duração do nível em jogo, ou do primeiro nível antes de o jogo começar. |
lateRegLevel | number | null | Sempre | O último nível em que um jogador ainda pode entrar, contando a partir do nível 1. null quando não há inscrição tardia. |
lateRegCloseAt | string (date-time) | null | Sempre | Quando a inscrição tardia fecha, quando há um horário para isso. |
lateRegClosed | boolean | Sempre | true quando as inscrições estão fechadas. Uma inscrição então responde 409 APP_REG_CLOSED. |
eventId | string | Quando se aplica | O evento do qual este torneio é um dia. Enviado só para um dia de um evento de vários dias, junto com os três campos seguintes. |
dayLabel | string | Quando se aplica | O nome do dia como o clube escreveu, como Day 1A ou Day 2. |
dayKind | "FLIGHT" | "ONLINE" | "DAY" | Quando se aplica | FLIGHT é um flight do Day 1, ONLINE um Day 1 cujas entradas a equipe digita, sem relógio, e DAY é o Day 2 ou depois. |
dayStep | number | Quando se aplica | 1 para os flights do Day 1, 2 para o Day 2, e assim por diante. |
buyInPartWord | "RAKE" | "FEE" | "CUSTOM" | Quando se aplica | A palavra do clube para a parte da casa no buy-in. Fica de fora quando é RAKE. |
buyInPartCustom | string | Quando se aplica | A palavra própria do clube, quando buyInPartWord é CUSTOM. |
detail
Os campos que só a resposta de detalhe tem, depois dos de um item da lista.
Onde fica na resposta: body
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
levels | level[] | Sempre | |
prizes | prize[] | Sempre | Vazio, a menos que o clube mostre os prêmios. |
players | player[] | Quando se aplica | Enviado só quando o clube mostra os nomes dos jogadores. |
lastUpdatedAt | string (date-time) | Sempre | Quando o torneio mudou pela última vez. |
serverTime | string (date-time) | Sempre | O nosso relógio quando respondemos, para você corrigir o seu. |
registeredCount | number | Quando se aplica | Inscrições que estão esperando, sentadas ou na lista de espera. Fica de fora quando o clube esconde os nomes dos jogadores. |
clockLayout | clockLayout | Quando se aplica | |
clockStyle | "classic" | "dial" | Quando se aplica | O estilo de relógio do clube no app dos jogadores. Um site pode ignorá-lo. |
clockValueOptions | clockValueOptions | Quando se aplica | |
pendingRegistrationCount | number | Quando se aplica | Inscrições esperando a equipe. Fica de fora quando o clube esconde o tamanho do field. |
appRegistrationEnabled | boolean | Sempre | Se o app dos jogadores aceita inscrições para este torneio agora. Veja na chamada de detalhe acima o que false quer dizer para as suas inscrições. |
appRegistrationLimit | number | null | Sempre | O máximo de inscrições que o torneio aceita, do app dos jogadores e do seu site juntos. null quer dizer sem limite. |
structureEstimate | structureEstimate | null | Quando se aplica | Enviado só quando o clube ativou, e só depois que a inscrição tardia fecha. |
gameStatus
O estado do relógio do torneio.
Onde fica na resposta: gameStatus
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
position | "Created" | "Running" | "Paused" | "Finished" | Sempre | Created: não começou. Running ou Paused: em jogo. Finished: acabou. |
currentLevelUuid | string | null | Sempre | O nível em jogo, como o uuid de um dos níveis. |
currentLevelStartTimestamp | number | null | Sempre | |
unTouchedCurrentLevelStartTimestamp | number | null | Sempre | |
currentLevelPauseStartTimestamp | number | null | Sempre | |
startTimestamp | number | null | Sempre | |
endTimestamp | number | null | Sempre | |
totalRunningTimeMs | number | Quando se aplica | |
tables | number[] | Sempre | Os números das mesas em jogo. Vazio quando o clube não mostra os assentos. |
handForHand | handForHand | Quando se aplica | |
lastHands | lastHands | Quando se aplica |
handForHand
Enviado só enquanto as mesas jogam hand for hand, e o torneio está rodando ou pausado.
Onde fica na resposta: gameStatus.handForHand
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
on | boolean | Sempre | |
hand | number | Sempre |
lastHands
Enviado só enquanto as últimas mãos são jogadas, e o torneio está rodando ou pausado.
Onde fica na resposta: gameStatus.lastHands
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
total | number | Sempre | |
current | number | Sempre |
settings
As configurações do torneio que os jogadores veem.
Onde fica na resposta: settings
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
buyIn | number | Sempre | O preço cheio de uma entrada. O rake e qualquer bounty estão dentro dele, nunca somados a ele. |
rake | number | Sempre | A parte da casa no buyIn. |
reEntryPrice | number | null | Quando se aplica | O preço de um re-entry ou de um rebuy, ou null quando não há. |
bounty | number | null | Sempre | A parte de bounty no buyIn, ou null quando não há. |
startingStack | number | Sempre | |
guarantee | number | null | Sempre | |
reEntryLimit | number | null | Sempre | |
format | "ReEntry" | "Freezeout" | "Rebuy" | Sempre | |
seatsPerTable | number | Quando se aplica | |
isDisplayPrizes | boolean | Sempre | true quando o clube mostra os prêmios. Quando é false, prizes fica vazio e info não traz os valores de premiação. |
isDisplayPotLimitBetRange | boolean | Sempre | |
startingLevelUuid | string | null | Quando se aplica | |
startingRemainingMs | number | null | Quando se aplica | |
showReEntries | boolean | Sempre | |
showTotalChips | boolean | Sempre | |
showAddOns | boolean | Sempre | |
rebuyStackLimit | number | null | Quando se aplica | |
addOn | addOn | null | Quando se aplica | O add-on, ou null quando o torneio não tem. |
showSeats | boolean | Sempre | false quando o clube não mostra quem senta onde. A mesa e o assento de cada jogador ficam então null. |
isAnnouncement | boolean | Sempre | |
announcement | string | Sempre | |
color | string | null | Sempre | A cor do relógio que o clube escolheu, como cor hex, ou null. |
addOn
O add-on, enquanto o torneio tiver um.
Onde fica na resposta: settings.addOn
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
afterLevel | number | Sempre | Vendido no intervalo depois deste nível. |
buyIn | number | Sempre | O preço cheio dele, com o rake dentro. |
stack | number | Sempre |
info
O field e a premiação. As contagens ficam de fora quando o clube esconde os jogadores, e os valores de premiação quando esconde os prêmios. Os campos de satélite são null num torneio que não é satélite.
Onde fica na resposta: info
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
bountyPool | number | Quando se aplica | |
activePlayers | number | Quando se aplica | |
aggregateEntries | number | Quando se aplica | |
aggregateReEntries | number | Quando se aplica | |
theoreticalTotalChips | number | Quando se aplica | |
aggregateAddOns | number | Quando se aplica | |
totalPrizePool | number | Quando se aplica | |
satelliteSeats | number | null | Quando se aplica | |
satelliteSeatMode | "GUARANTEED" | "AUTO" | null | Quando se aplica | |
satelliteTargetStack | number | null | Quando se aplica | |
satelliteQualified | number | null | Quando se aplica | |
qualifiedStackTotal | number | null | Quando se aplica |
level
Um nível de blinds ou um intervalo, na ordem de jogo.
Onde fica na resposta: levels[]
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
lengthInMinuets | number | Sempre | A duração do nível em minutos. O nome do campo é escrito assim mesmo. |
in | number | Sempre | O small blind. |
out | number | Sempre | O big blind. |
ante | number | Sempre | |
isBreak | boolean | Sempre | |
order | number | Sempre | |
orderWithBreaks | number | Sempre | |
uuid | string | Sempre | O ID do nível, como em gameStatus.currentLevelUuid. |
prize
Uma posição na lista de prêmios. A lista fica vazia, a menos que o clube mostre os prêmios.
Onde fica na resposta: prizes[]
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
place | number | Sempre | |
prizeAmount | number | null | Sempre | |
prizePercentage | number | Sempre | |
prizeType | "cash" | "seat" | Quando se aplica | seat quando o prêmio é um assento em outro torneio. |
seatLabel | string | null | Quando se aplica |
player
Um jogador. Enviado só quando o clube mostra os nomes dos jogadores.
Onde fica na resposta: players[]
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
name | string | Sempre | |
entries | number | Sempre | |
busted | boolean | Sempre | true quando o jogador foi eliminado. |
qualified | boolean | Sempre | true quando o jogador ganhou um assento num satélite. |
chips | number | null | Quando se aplica | As fichas do jogador, ou null quando o clube não mostra as fichas. |
placed | number | null | Quando se aplica | A posição final do jogador, quando o clube mostra as posições. |
placedTo | number | Quando se aplica | O fim de uma posição dividida: placed 22 e placedTo 23 é do 22º ao 23º. |
payout | number | Quando se aplica | O prêmio em dinheiro do jogador. Enviado só quando o clube mostra posições e prêmios. |
knockouts | number | Quando se aplica | |
rebuys | number | Sempre | |
addOns | number | Sempre | |
tableNumber | number | null | Sempre | null quando o jogador não tem assento, ou o clube não mostra os assentos. |
seatNumber | number | null | Sempre | null quando o jogador não tem assento, ou o clube não mostra os assentos. |
structureEstimate
Mais ou menos quando o torneio termina, como uma faixa.
Onde fica na resposta: structureEstimate
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
loMin | number | Sempre | O começo da faixa, em minutos desde o início. |
hiMin | number | Sempre | O fim da faixa, em minutos desde o início. |
loAt | string (date-time) | null | Sempre | O começo da faixa como horário, quando o início é conhecido. |
hiAt | string (date-time) | null | Sempre | O fim da faixa como horário, quando o início é conhecido. |
clockLayout
Como a tela do relógio do clube aparece no app dos jogadores, junto com as três tabelas seguintes. Um site pode ignorá-las.
Onde fica na resposta: clockLayout
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
open | clockState | Sempre | |
closed | clockState | Sempre |
clockState
Parte do layout do relógio: o relógio enquanto as inscrições estão abertas, e depois que fecham.
Onde fica na resposta: clockLayout.open · clockLayout.closed
clockSide
Parte do layout do relógio: o que um lado do relógio mostra.
Onde fica na resposta: clockLayout.*.left · clockLayout.*.right
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
mode | "list" | "thirds" | Sempre | |
values | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Quando se aplica | |
top | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Quando se aplica | |
middle | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Quando se aplica | |
bottom | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Quando se aplica |
clockValueOptions
Parte do layout do relógio: como alguns valores aparecem escritos no relógio.
Onde fica na resposta: clockValueOptions
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
buyInSplit | boolean | Sempre | |
lateRegFormat | "level" | "time" | Sempre | |
prizeListMotion | "pages" | "bounce" | "loop" | Sempre | |
avgStackInBb | boolean | Sempre | |
startingStackInBb | boolean | Sempre |
registration
A resposta a uma inscrição.
Onde fica na resposta: body
| Campo | Tipo | Enviado | Significado |
|---|---|---|---|
registrationId | string | Sempre | O ID da inscrição. |
status | "PENDING" | Sempre | Sempre PENDING: a inscrição espera a equipe. |
playerId | string | Sempre | O ID do jogador na lista de jogadores do seu clube. Envie como playerId da próxima vez. |
createdPlayer | boolean | Sempre | true quando esta chamada adicionou o jogador à lista de jogadores. |
O que a API não faz
A versão 1 não tem nada disto:
- Listar ou buscar os jogadores do clube, ou ler o telefone ou o e-mail de alguém. As respostas não trazem dados de contato.
- Adicionar um jogador sem uma inscrição, ou mudar os dados de um jogador.
- Ler, cancelar ou mudar uma inscrição depois de enviada.
- Sentar um jogador, cobrar um pagamento ou registrar um buy-in.
- Criar ou mudar um torneio, ou mudar qualquer outra coisa no clube.
- Ler o dinheiro do clube: pagamentos ou receitas. Os prêmios, a premiação e o prêmio de cada jogador aparecem só como os jogadores veem, quando o clube os mostra.
- Paginar ou filtrar a lista de torneios. Ela tem no máximo 200, sem página seguinte.
- Listar torneios encerrados ou passados. Em vez disso, leia um torneio encerrado pelo ID dele.
- Ver torneios ocultos para os jogadores, ou o torneio de treino.
- Ser chamada de uma página no navegador. Uma chamada que traz o cabeçalho
Originde um navegador no seu site é recusada. - Agir por outro clube. Uma chave lê e envia inscrições só para o próprio clube, e qualquer outro torneio responde
404. - Criar, listar ou revogar chaves. Só o dono faz isso, no app web.
- Avisar o seu servidor quando algo muda. Não há webhooks: leia a lista de novo quando precisar.
Limites e erros
Cada chave pode fazer 10 chamadas por segundo e 300 chamadas em 10 minutos, somando as três chamadas, e enviar 200 inscrições novas em quaisquer 24 horas. Uma inscrição enviada de novo depois que a equipe a recusou conta como nova. Repetir uma inscrição que ainda espera não conta para as 200. Além disso, as chamadas de um mesmo endereço IP têm limite em cada uma das três chamadas: 30 por segundo, 150 em 10 segundos e 600 por minuto, sejam quais forem as chaves usadas.
| Status | errorCode | O que quer dizer | O que fazer |
|---|---|---|---|
| 400 | Nenhum | O corpo está errado: não é um JSON válido, falta um campo, ele está vazio, é longo demais ou não é permitido, o e-mail é inválido, as duas formas foram enviadas, veio um nome sem telefone nem e-mail, ou o telefone é inválido ou de mentira. | Corrija o pedido. A mensagem diz o que está errado. |
| 401 | Nenhum | A chave está faltando, não foi enviada com ClubKey e um espaço antes, está errada ou foi revogada. | Confira a chave. Se ela foi revogada, peça uma nova ao dono do clube. |
| 403 | CLUB_API_NEEDS_PLAN | O clube não tem plano: está no teste grátis, o plano terminou, ou a assinatura está sem pagamento. | Peça ao clube para escolher um plano. A chave volta a funcionar assim que ele escolher. |
| 403 | Nenhum | A chave não tem o acesso que esta chamada precisa. | Peça ao dono uma chave com esse acesso. |
| 403 | CLUB_API_BROWSER_BLOCKED | A chamada trazia o cabeçalho Origin de um navegador no seu site. As chamadas vêm só do seu servidor. | Chame do seu servidor, sem o cabeçalho Origin. |
| 403 | APP_REG_DISABLED | As inscrições estão desligadas neste torneio, ou este jogador não pode se inscrever neste clube. | Não tente de novo. Diga ao jogador para falar com o clube. |
| 404 | Nenhum | O torneio não é um que a sua chave pode ver (de outro clube, oculto para os jogadores, o de treino, ou um ID que não existe), ou o jogador não está na lista de jogadores do clube. | Confira o ID, e liste os torneios de novo. |
| 409 | APP_REG_CLOSED | As inscrições deste torneio estão fechadas: a inscrição tardia acabou, a equipe fechou as inscrições, o último nível acabou enquanto a equipe fecha os resultados, ou o torneio terminou. | Não tente de novo. Pare de oferecer inscrição para este torneio. |
| 409 | APP_REG_CAP_FULL | O torneio chegou ao limite de inscrições, que está em details.limit. | Não tente de novo, a não ser que abra uma vaga. |
| 409 | APP_REG_ALREADY_ENTERED | O jogador já está jogando este torneio. | Nada: o jogador está dentro. |
| 409 | TOURNAMENT_BUSY | Alguém salvou este torneio no mesmo instante. Nada foi mudado. | Tente de novo em um instante. |
| 413 | PAYLOAD_TOO_LARGE | O corpo passa de 100 kB. | Envie só os campos desta página. |
| 429 | CLUB_KEY_DAILY_SIGNUP_LIMIT | A chave enviou 200 inscrições novas nas últimas 24 horas, o limite que está em details.limit. | Espere os segundos do cabeçalho Retry-After, que também estão em details.retryAfterSeconds: até lá uma inscrição terá saído das 24 horas. |
| 429 | Nenhum | Chamadas demais: mais de 10 por segundo ou 300 em 10 minutos para esta chave, ou acima dos limites do seu endereço IP. Passadas as 300 chamadas, a chave fica recusada por até 10 minutos. | Espere os segundos do cabeçalho Retry-After e depois chame com menos frequência. Os limites do endereço IP enviam Retry-After-short, Retry-After-medium ou Retry-After-long no lugar dele. |
| 500 | INTERNAL_ERROR | Algo falhou do nosso lado. | Tente de novo depois de uma pequena espera. Repetir uma inscrição é seguro. |
| 503 | DB_STATEMENT_TIMEOUT | O nosso banco de dados demorou demais para responder. Nada foi mudado. | Tente de novo depois de uma pequena espera. |
Mudanças
Esta é a versão 1, chamada v1 em todo caminho. Nós só adicionamos: campos novos nas respostas, nunca um removido ou renomeado. Ignore os campos que você não conhece, assim um campo novo nunca causa erro no seu código.
Dúvidas sobre a API? Fale com a gente.