API para clubes
Versión 1. El servidor del sitio web de tu club puede mostrar los torneos del club y enviarle registros de jugadores. Esta página lista cada llamada, campo y error, y lo que la API no hace.
Para qué sirve
Un club de poker maneja sus torneos en LynxPoker. Con una clave de API del club, el propio sitio web del club puede mostrar esos torneos y dejar que los jugadores se registren en ellos ahí.
Un registro desde el sitio web nunca sienta al jugador y nunca cobra un pago. Espera en LynxPoker hasta que el equipo del club siente al jugador o rechace el registro.
Antes de empezar
- Solo el dueño del club puede crear una clave, en la app web de LynxPoker, en Configuración y luego Claves de API. El dueño elige un nombre y lo que la clave puede hacer. Un club puede tener hasta 20 claves activas.
- Una clave necesita un plan. Un club en su prueba gratis no puede crear una. Cuenta cualquier plan, sin importar cómo lo pague el club, y también un plan que le dimos al club. Si falla el pago con tarjeta del club, sus claves siguen funcionando mientras se vuelve a intentar el pago. Cuando la suscripción queda impaga, o el plan termina, cada llamada con sus claves se rechaza con
403CLUB_API_NEEDS_PLAN. Guardamos las claves, y vuelven a funcionar en la siguiente llamada en cuanto el club tenga un plan. - Mostramos una clave solo una vez, al crearla. Si se pierde, el dueño la revoca y crea una nueva. Una clave revocada deja de funcionar al instante y no se puede volver a activar.
- Llama a la API solo desde tu servidor. La clave es secreta: nunca la pongas en una página web, una app móvil o un repositorio de código público. Una llamada que trae el encabezado
Originde un navegador en tu sitio se rechaza con403CLUB_API_BROWSER_BLOCKED. Si tu servidor nos pasa la solicitud de un visitante, no copies los encabezados del navegador.
Claves y respuestas
Cada llamada va a esta dirección. Las rutas de esta página empiezan con /api.
https://api.lynx.pokerEnvía la clave en el encabezado Authorization de cada llamada, después de la palabra ClubKey y un espacio:
Authorization: ClubKey <keyId>.<secret>Una clave son dos partes unidas por un punto: el ID de la clave y el secreto. Envíala tal como la copiaste.
Lo que una clave puede hacer
El dueño lo elige al crear la clave. Una llamada que necesita un acceso que la clave no tiene se rechaza con 403.
| Acceso | Nombre en la app | Llamadas |
|---|---|---|
TOURNAMENTS_READ | Leer torneos | GET /api/club-api/v1/tournaments GET /api/club-api/v1/tournaments/:id |
REGISTRATIONS_CREATE | Enviar registros | POST /api/club-api/v1/tournaments/:id/registrations |
Respuestas
Cada respuesta es JSON. Una respuesta exitosa trae sus datos en body. Su campo status siempre dice 200, así que lee el estado HTTP: 200 para una lectura, 201 para un registro.
Una respuesta de error tiene el estado HTTP, un message para personas y, en la mayoría de los errores, un errorCode. Lee el estado HTTP y el errorCode, nunca el mensaje: los mensajes pueden cambiar.
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"
}Llamadas
Listar los torneos del club
GET/api/club-api/v1/tournaments
Acceso necesario: TOURNAMENTS_READ
Devuelve los torneos en juego o en pausa ahora, y luego los que aún no empiezan y están programados para los próximos 30 días. Un torneo que no ha empezado sigue en la lista 6 horas después de su inicio programado. La lista tiene como máximo 200: primero los que están en vivo, luego por inicio programado. Un torneo que aún no empieza solo aparece si tiene un inicio programado. Los torneos terminados nunca aparecen en la lista: lee uno por su ID.
Los torneos ocultos para los jugadores y el torneo de práctica del club nunca aparecen en la lista.
Cada elemento es el resumen que muestra la app de jugadores de LynxPoker: el buy-in, el inicio, cuándo cierra el registro tardío, y el tamaño del field y el prize pool cuando el club los muestra. serverTime es nuestro reloj, para que corrijas el tuyo.
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"
}
}Errores que esta llamada puede devolver: 401, 403, 429, 500, 503
Ver un torneo
GET/api/club-api/v1/tournaments/:id
Acceso necesario: TOURNAMENTS_READ
Devuelve un torneo de tu club, en cualquier estado, también después de que termina. Tiene todos los campos de un elemento de la lista, más los niveles de ciegas, los premios, y los jugadores cuando el club muestra sus nombres. Sigue la configuración del club para la app de jugadores, así que muestra solo lo que ven los jugadores.
lateRegClosed es true cuando los registros están cerrados: un registro responde entonces 409 APP_REG_CLOSED. appRegistrationEnabled es false cuando la app de jugadores no acepta registros para este torneo. Puede ser una decisión del club solo para la app de jugadores, o que los registros estén apagados para este torneo, lo que también rechaza tus registros con 403 APP_REG_DISABLED. appRegistrationLimit es el máximo de registros que acepta el torneo, desde la app de jugadores y tu sitio juntos, y null significa sin límite. Ningún campo promete que un registro va a pasar: lo que decide es la respuesta al registro.
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
}
}Acortada: la respuesta real también tiene todos los campos de un elemento de la lista. <fields>Campos de la respuesta</fields> lista todos los campos.
Errores que esta llamada puede devolver: 401, 403, 404, 429, 500, 503
Enviar un registro
POST/api/club-api/v1/tournaments/:id/registrations
Acceso necesario: REGISTRATIONS_CREATE
Pide registrar a un jugador en un torneo. Envía el ID del jugador en la lista de jugadores del club, o el nombre del jugador con un teléfono, un correo o ambos. Nunca las dos formas en la misma llamada.
| Campo | Tipo | Obligatorio | Reglas |
|---|---|---|---|
playerId | string | Envía este, o name | El ID de un jugador de la lista de jugadores de tu club. Máximo 64 caracteres. |
name | string | Sí, sin playerId | El nombre del jugador. No vacío, máximo 120 caracteres. |
phone | string | Un teléfono, un correo o ambos, sin playerId | Máximo 32 caracteres. Mira las reglas del teléfono más abajo. |
email | string | Un teléfono, un correo o ambos, sin playerId | Una dirección de correo válida, máximo 254 caracteres. |
Envía solo estos campos: cualquier otro campo se rechaza con 400. Un campo enviado como null cuenta como no 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"}'La respuesta es 201 con el registro. Su status siempre es PENDING. createdPlayer es true cuando esta llamada agregó al jugador a la lista de jugadores del club.
HTTP/1.1 201 Created
{
"status": 200,
"body": {
"registrationId": "7d0c2f4e-8b1a-4e5f-a3c6-91b2d4e6f8a0",
"status": "PENDING",
"playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e",
"createdPlayer": true
}
}Errores que esta llamada puede devolver: 400, 401, 403, 404, 409, 413, 429, 500, 503
Cómo encontramos al jugador
Con playerId, usamos ese jugador. Tiene que estar en la lista de jugadores de tu club, si no la respuesta es 404.
Con un nombre, buscamos entre los jugadores de tu club el mismo número de teléfono o el mismo correo. Un correo coincide sin importar mayúsculas y minúsculas. El nombre nunca se usa para encontrar a alguien.
Si coinciden varios jugadores, tomamos el que tiene el mismo teléfono y el mismo correo, luego el mismo teléfono, luego el mismo correo. Entre iguales, tomamos el que el equipo actualizó por última vez.
Si encontramos al jugador, lo usamos y no cambiamos nada de sus datos. Si no, agregamos un jugador nuevo a la lista de jugadores del club con el nombre, el teléfono y el correo que enviaste.
Un número de teléfono sin + se lee como un número del país del club, o de Israel cuando el club no tiene país. Para un número de otro país, empieza con + y el código del país. Un número no válido se rechaza con 400.
Un número de relleno, cuyos últimos 7 dígitos son todos iguales, como 050-0000000, se rechaza con 400 salvo que también envíes un correo. Entonces encontramos al jugador por el correo.
Enviar el mismo registro otra vez mientras espera devuelve el mismo registro, con el mismo registrationId, y no cambia nada. Así puedes reintentar sin riesgo una llamada que no respondió a tiempo. Esto vale solo mientras los registros están abiertos: cuando se cierran, una repetición responde 409 APP_REG_CLOSED, y cuando los registros del torneo se apagan, 403 APP_REG_DISABLED.
Qué pasa después
El registro aparece en la lista Jugadores registrados del torneo en LynxPoker, marcado Desde el sitio web, y el equipo recibe la misma alerta que por un registro desde la app de jugadores. En la caja, el equipo sienta al jugador o rechaza el registro.
La API no puede decirle a tu sitio lo que decidió el equipo. Ninguna llamada lee un registro, y no enviamos webhooks. Si el jugador usa la app de jugadores de LynxPoker y está conectado al club, la app le avisa cuando lo sientan.
Repetir la llamada no sirve para verificar. Cuando el jugador ya está sentado o en la lista de espera, una repetición responde 409 APP_REG_ALREADY_ENTERED. Después de que el equipo rechaza un registro, o cuando el jugador queda eliminado o es quitado, una repetición envía un registro nuevo.
Campos de la respuesta
Todos los campos que pueden traer nuestras respuestas, tomados de la propia definición de la API. El significado de un campo aparece cuando su nombre no lo dice.
Las horas son texto en UTC, como 2026-11-12T18:00:00.000Z. Un campo cuyo nombre termina en Timestamp es un número de milisegundos desde el 1 de enero de 1970, en UTC. Los montos de dinero son números simples, sin moneda.
Un campo marcado "cuando aplica" no viene en la respuesta cuando no aplica. null solo aparece en un campo cuyo tipo lo incluye.
list
La respuesta a la llamada de la lista.
Dónde está en la respuesta: body
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
items | tournament[] | Siempre | |
serverTime | string (date-time) | Siempre | Nuestro reloj cuando respondimos, para que corrijas el tuyo. |
tournament
Un torneo: cada elemento de la lista, y el comienzo de la respuesta de detalle.
Dónde está en la respuesta: body.items[] · body
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
id | string | Siempre | El ID del torneo, para las llamadas de detalle y de registro. |
organizationId | string | Siempre | El ID de tu club. |
timeFormat | "12h" | "24h" | Siempre | Cómo escribe las horas el club: reloj de 12 o de 24 horas. |
dateFormat | "dmy" | "mdy" | Siempre | Cómo escribe las fechas el club: primero el día (dmy) o primero el mes (mdy). |
title | string | Siempre | |
description | string | null | Siempre | |
game | "Holdem" | "Omaha" | Siempre | |
type | "Regular" | "Mystery" | "Bounty" | "Progressive" | "Satellite" | Siempre | |
format | "ReEntry" | "Freezeout" | "Rebuy" | Siempre | |
scheduledStartAt | string (date-time) | null | Siempre | El inicio programado. null en cuanto empieza el juego. |
startingTime | string (date-time) | null | Siempre | Cuándo empezó el juego. null antes de eso. |
gameStatus | gameStatus | Siempre | |
settings | settings | Siempre | |
info | info | Siempre | |
levelDurationMinutes | number | null | Siempre | La duración del nivel en juego, o del primer nivel antes de que empiece el juego. |
lateRegLevel | number | null | Siempre | El último nivel en el que un jugador todavía puede entrar, contando desde el nivel 1. null cuando no hay registro tardío. |
lateRegCloseAt | string (date-time) | null | Siempre | Cuándo cierra el registro tardío, cuando hay una hora para eso. |
lateRegClosed | boolean | Siempre | true cuando los registros están cerrados. Un registro responde entonces 409 APP_REG_CLOSED. |
eventId | string | Cuando aplica | El evento del que este torneo es un día. Se envía solo para un día de un evento de varios días, junto con los tres campos siguientes. |
dayLabel | string | Cuando aplica | El nombre del día tal como lo escribió el club, como Day 1A o Day 2. |
dayKind | "FLIGHT" | "ONLINE" | "DAY" | Cuando aplica | FLIGHT es un flight del Day 1, ONLINE un Day 1 cuyas entradas escribe el equipo, sin reloj, y DAY es el Day 2 o después. |
dayStep | number | Cuando aplica | 1 para los flights del Day 1, 2 para el Day 2, y así sucesivamente. |
buyInPartWord | "RAKE" | "FEE" | "CUSTOM" | Cuando aplica | La palabra del club para la parte de la casa en el buy-in. No viene cuando es RAKE. |
buyInPartCustom | string | Cuando aplica | La palabra propia del club, cuando buyInPartWord es CUSTOM. |
detail
Los campos que solo tiene la respuesta de detalle, después de los de un elemento de la lista.
Dónde está en la respuesta: body
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
levels | level[] | Siempre | |
prizes | prize[] | Siempre | Vacío a menos que el club muestre los premios. |
players | player[] | Cuando aplica | Se envía solo cuando el club muestra los nombres de los jugadores. |
lastUpdatedAt | string (date-time) | Siempre | Cuándo cambió el torneo por última vez. |
serverTime | string (date-time) | Siempre | Nuestro reloj cuando respondimos, para que corrijas el tuyo. |
registeredCount | number | Cuando aplica | Registros que están esperando, sentados o en la lista de espera. No viene cuando el club oculta los nombres de los jugadores. |
clockLayout | clockLayout | Cuando aplica | |
clockStyle | "classic" | "dial" | Cuando aplica | El estilo de reloj del club en la app de jugadores. Un sitio puede ignorarlo. |
clockValueOptions | clockValueOptions | Cuando aplica | |
pendingRegistrationCount | number | Cuando aplica | Registros que esperan al equipo. No viene cuando el club oculta el tamaño del field. |
appRegistrationEnabled | boolean | Siempre | Si la app de jugadores acepta registros para este torneo ahora. Mira en la llamada de detalle de arriba qué significa false para tus registros. |
appRegistrationLimit | number | null | Siempre | El máximo de registros que acepta el torneo, desde la app de jugadores y tu sitio juntos. null significa sin límite. |
structureEstimate | structureEstimate | null | Cuando aplica | Se envía solo cuando el club lo activó, y solo cuando el registro tardío ya cerró. |
gameStatus
El estado del reloj del torneo.
Dónde está en la respuesta: gameStatus
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
position | "Created" | "Running" | "Paused" | "Finished" | Siempre | Created: no ha empezado. Running o Paused: en juego. Finished: terminó. |
currentLevelUuid | string | null | Siempre | El nivel en juego, como el uuid de uno de los niveles. |
currentLevelStartTimestamp | number | null | Siempre | |
unTouchedCurrentLevelStartTimestamp | number | null | Siempre | |
currentLevelPauseStartTimestamp | number | null | Siempre | |
startTimestamp | number | null | Siempre | |
endTimestamp | number | null | Siempre | |
totalRunningTimeMs | number | Cuando aplica | |
tables | number[] | Siempre | Los números de las mesas en juego. Vacío cuando el club no muestra los asientos. |
handForHand | handForHand | Cuando aplica | |
lastHands | lastHands | Cuando aplica |
handForHand
Se envía solo mientras las mesas juegan mano a mano, y el torneo está en juego o en pausa.
Dónde está en la respuesta: gameStatus.handForHand
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
on | boolean | Siempre | |
hand | number | Siempre |
lastHands
Se envía solo mientras se juegan las últimas manos, y el torneo está en juego o en pausa.
Dónde está en la respuesta: gameStatus.lastHands
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
total | number | Siempre | |
current | number | Siempre |
settings
La configuración del torneo que ven los jugadores.
Dónde está en la respuesta: settings
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
buyIn | number | Siempre | El precio completo de una entrada. El rake y cualquier bounty están dentro de él, nunca se suman. |
rake | number | Siempre | La parte de la casa en buyIn. |
reEntryPrice | number | null | Cuando aplica | El precio de un re-entry o de un rebuy, o null cuando no hay. |
bounty | number | null | Siempre | La parte de bounty en buyIn, o null cuando no hay. |
startingStack | number | Siempre | |
guarantee | number | null | Siempre | |
reEntryLimit | number | null | Siempre | |
format | "ReEntry" | "Freezeout" | "Rebuy" | Siempre | |
seatsPerTable | number | Cuando aplica | |
isDisplayPrizes | boolean | Siempre | true cuando el club muestra los premios. Cuando es false, prizes está vacío e info no trae las bolsas. |
isDisplayPotLimitBetRange | boolean | Siempre | |
startingLevelUuid | string | null | Cuando aplica | |
startingRemainingMs | number | null | Cuando aplica | |
showReEntries | boolean | Siempre | |
showTotalChips | boolean | Siempre | |
showAddOns | boolean | Siempre | |
rebuyStackLimit | number | null | Cuando aplica | |
addOn | addOn | null | Cuando aplica | El add-on, o null cuando el torneo no tiene. |
showSeats | boolean | Siempre | false cuando el club no muestra quién se sienta dónde. La mesa y el asiento de cada jugador son entonces null. |
isAnnouncement | boolean | Siempre | |
announcement | string | Siempre | |
color | string | null | Siempre | El color del reloj que eligió el club, como color hex, o null. |
addOn
El add-on, mientras el torneo tenga uno.
Dónde está en la respuesta: settings.addOn
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
afterLevel | number | Siempre | Se vende en el descanso después de este nivel. |
buyIn | number | Siempre | Su precio completo, con el rake dentro. |
stack | number | Siempre |
info
El field y la bolsa de premios. Los conteos no vienen cuando el club oculta a sus jugadores, y las bolsas no vienen cuando oculta los premios. Los campos de satélite son null en un torneo que no es satélite.
Dónde está en la respuesta: info
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
bountyPool | number | Cuando aplica | |
activePlayers | number | Cuando aplica | |
aggregateEntries | number | Cuando aplica | |
aggregateReEntries | number | Cuando aplica | |
theoreticalTotalChips | number | Cuando aplica | |
aggregateAddOns | number | Cuando aplica | |
totalPrizePool | number | Cuando aplica | |
satelliteSeats | number | null | Cuando aplica | |
satelliteSeatMode | "GUARANTEED" | "AUTO" | null | Cuando aplica | |
satelliteTargetStack | number | null | Cuando aplica | |
satelliteQualified | number | null | Cuando aplica | |
qualifiedStackTotal | number | null | Cuando aplica |
level
Un nivel de ciegas o un descanso, en el orden de juego.
Dónde está en la respuesta: levels[]
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
lengthInMinuets | number | Siempre | La duración del nivel en minutos. El nombre del campo se escribe así. |
in | number | Siempre | La ciega pequeña. |
out | number | Siempre | La ciega grande. |
ante | number | Siempre | |
isBreak | boolean | Siempre | |
order | number | Siempre | |
orderWithBreaks | number | Siempre | |
uuid | string | Siempre | El ID del nivel, como en gameStatus.currentLevelUuid. |
prize
Un puesto de la lista de premios. La lista está vacía a menos que el club muestre los premios.
Dónde está en la respuesta: prizes[]
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
place | number | Siempre | |
prizeAmount | number | null | Siempre | |
prizePercentage | number | Siempre | |
prizeType | "cash" | "seat" | Cuando aplica | seat cuando el premio es un asiento en otro torneo. |
seatLabel | string | null | Cuando aplica |
player
Un jugador. Se envía solo cuando el club muestra los nombres de los jugadores.
Dónde está en la respuesta: players[]
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
name | string | Siempre | |
entries | number | Siempre | |
busted | boolean | Siempre | true cuando el jugador quedó eliminado. |
qualified | boolean | Siempre | true cuando el jugador ganó un asiento en un satélite. |
chips | number | null | Cuando aplica | Las fichas del jugador, o null cuando el club no muestra las fichas. |
placed | number | null | Cuando aplica | El puesto final del jugador, cuando el club muestra los puestos. |
placedTo | number | Cuando aplica | El final de un puesto compartido: placed 22 y placedTo 23 es del 22.º al 23.º. |
payout | number | Cuando aplica | El premio en dinero del jugador. Se envía solo cuando el club muestra puestos y premios. |
knockouts | number | Cuando aplica | |
rebuys | number | Siempre | |
addOns | number | Siempre | |
tableNumber | number | null | Siempre | null cuando el jugador no tiene asiento, o el club no muestra los asientos. |
seatNumber | number | null | Siempre | null cuando el jugador no tiene asiento, o el club no muestra los asientos. |
structureEstimate
Más o menos cuándo termina el torneo, como un rango.
Dónde está en la respuesta: structureEstimate
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
loMin | number | Siempre | El extremo temprano del rango, en minutos desde el inicio. |
hiMin | number | Siempre | El extremo tardío del rango, en minutos desde el inicio. |
loAt | string (date-time) | null | Siempre | El extremo temprano como hora, cuando se conoce el inicio. |
hiAt | string (date-time) | null | Siempre | El extremo tardío como hora, cuando se conoce el inicio. |
clockLayout
Cómo se ve la pantalla del reloj del club en la app de jugadores, junto con las tres tablas siguientes. Un sitio puede ignorarlas.
Dónde está en la respuesta: clockLayout
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
open | clockState | Siempre | |
closed | clockState | Siempre |
clockState
Parte del diseño del reloj: el reloj mientras los registros están abiertos, y cuando se cierran.
Dónde está en la respuesta: clockLayout.open · clockLayout.closed
clockSide
Parte del diseño del reloj: lo que muestra un lado del reloj.
Dónde está en la respuesta: clockLayout.*.left · clockLayout.*.right
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
mode | "list" | "thirds" | Siempre | |
values | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Cuando aplica | |
top | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Cuando aplica | |
middle | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Cuando aplica | |
bottom | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | Cuando aplica |
clockValueOptions
Parte del diseño del reloj: cómo se escriben algunos valores en el reloj.
Dónde está en la respuesta: clockValueOptions
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
buyInSplit | boolean | Siempre | |
lateRegFormat | "level" | "time" | Siempre | |
prizeListMotion | "pages" | "bounce" | "loop" | Siempre | |
avgStackInBb | boolean | Siempre | |
startingStackInBb | boolean | Siempre |
registration
La respuesta a un registro.
Dónde está en la respuesta: body
| Campo | Tipo | Se envía | Significado |
|---|---|---|---|
registrationId | string | Siempre | El ID del registro. |
status | "PENDING" | Siempre | Siempre PENDING: el registro espera al equipo. |
playerId | string | Siempre | El ID del jugador en la lista de jugadores de tu club. Envíalo como playerId la próxima vez. |
createdPlayer | boolean | Siempre | true cuando esta llamada agregó al jugador a la lista de jugadores. |
Lo que la API no hace
La versión 1 no tiene nada de esto:
- Listar o buscar a los jugadores del club, ni leer el teléfono o el correo de nadie. Las respuestas no traen datos de contacto.
- Agregar un jugador sin un registro, ni cambiar los datos de un jugador.
- Leer, cancelar o cambiar un registro después de enviarlo.
- Sentar a un jugador, cobrar un pago ni registrar un buy-in.
- Crear o cambiar un torneo, ni cambiar nada más en el club.
- Leer el dinero del club: pagos ni ingresos. Los premios, la bolsa de premios y el premio de cada jugador se ven solo como los ven los jugadores, cuando el club los muestra.
- Paginar o filtrar la lista de torneos. Tiene como máximo 200, sin página siguiente.
- Listar torneos terminados o pasados. En su lugar, lee un torneo terminado por su ID.
- Ver torneos ocultos para los jugadores, ni el torneo de práctica.
- Recibir llamadas desde una página en el navegador. Una llamada que trae el encabezado
Originde un navegador en tu sitio se rechaza. - Actuar por otro club. Una clave lee y envía registros solo para su propio club, y cualquier otro torneo responde
404. - Crear, listar o revocar claves. Solo el dueño lo hace, en la app web.
- Avisar a tu servidor cuando algo cambia. No hay webhooks: vuelve a leer la lista cuando lo necesites.
Límites y errores
Cada clave puede hacer 10 llamadas por segundo y 300 llamadas en 10 minutos, sumando las tres llamadas, y enviar 200 registros nuevos en cualquier lapso de 24 horas. Un registro enviado otra vez después de que el equipo lo rechazó cuenta como nuevo. Repetir un registro que todavía espera no cuenta para los 200. Además, las llamadas desde una misma dirección IP tienen un límite en cada una de las tres llamadas: 30 por segundo, 150 en 10 segundos y 600 por minuto, sin importar qué claves usen.
| Estado | errorCode | Qué significa | Qué hacer |
|---|---|---|---|
| 400 | Ninguno | El cuerpo está mal: no es un JSON válido, falta un campo, está vacío, es demasiado largo o no está permitido, el correo no es válido, se enviaron las dos formas, llegó un nombre sin teléfono ni correo, o el teléfono no es válido o es de relleno. | Corrige la solicitud. El mensaje dice qué está mal. |
| 401 | Ninguno | La clave falta, no se envió con ClubKey y un espacio antes, está mal o fue revocada. | Revisa la clave. Si fue revocada, pide una nueva al dueño del club. |
| 403 | CLUB_API_NEEDS_PLAN | El club no tiene plan: está en su prueba gratis, su plan terminó, o su suscripción está impaga. | Pide al club que elija un plan. La clave vuelve a funcionar en cuanto lo haga. |
| 403 | Ninguno | La clave no tiene el acceso que esta llamada necesita. | Pide al dueño una clave con ese acceso. |
| 403 | CLUB_API_BROWSER_BLOCKED | La llamada traía el encabezado Origin de un navegador en tu sitio. Las llamadas vienen solo de tu servidor. | Llama desde tu servidor, sin el encabezado Origin. |
| 403 | APP_REG_DISABLED | Los registros están apagados en este torneo, o este jugador no puede registrarse en este club. | No reintentes. Dile al jugador que contacte al club. |
| 404 | Ninguno | El torneo no es uno que tu clave pueda ver (de otro club, oculto para los jugadores, el de práctica, o un ID que no existe), o el jugador no está en la lista de jugadores del club. | Revisa el ID, y vuelve a listar los torneos. |
| 409 | APP_REG_CLOSED | Los registros de este torneo están cerrados: terminó el registro tardío, el equipo cerró los registros, el último nivel terminó mientras el equipo cierra los resultados, o el torneo terminó. | No reintentes. Deja de ofrecer el registro para este torneo. |
| 409 | APP_REG_CAP_FULL | El torneo llegó a su límite de registros, que está en details.limit. | No reintentes, salvo que se libere un lugar. |
| 409 | APP_REG_ALREADY_ENTERED | El jugador ya está jugando este torneo. | Nada: el jugador está adentro. |
| 409 | TOURNAMENT_BUSY | Alguien guardó este torneo en el mismo momento. No se cambió nada. | Vuelve a intentar en un momento. |
| 413 | PAYLOAD_TOO_LARGE | El cuerpo pasa de 100 kB. | Envía solo los campos de esta página. |
| 429 | CLUB_KEY_DAILY_SIGNUP_LIMIT | La clave envió 200 registros nuevos en las últimas 24 horas, el límite que está en details.limit. | Espera los segundos del encabezado Retry-After, que también están en details.retryAfterSeconds: para entonces un registro habrá salido de las 24 horas. |
| 429 | Ninguno | Demasiadas llamadas: más de 10 por segundo o 300 en 10 minutos para esta clave, o por encima de los límites de tu dirección IP. Pasadas las 300 llamadas, la clave queda rechazada hasta 10 minutos. | Espera los segundos del encabezado Retry-After y luego llama con menos frecuencia. Los límites por dirección IP envían en su lugar Retry-After-short, Retry-After-medium o Retry-After-long. |
| 500 | INTERNAL_ERROR | Algo falló de nuestro lado. | Vuelve a intentar después de una breve espera. Repetir un registro es seguro. |
| 503 | DB_STATEMENT_TIMEOUT | Nuestra base de datos tardó demasiado en responder. No se cambió nada. | Vuelve a intentarlo después de una breve espera. |
Cambios
Esta es la versión 1, llamada v1 en cada ruta. Solo le agregamos cosas: campos nuevos en las respuestas, nunca uno eliminado o renombrado. Ignora los campos que no conozcas, así un campo nuevo nunca rompe tu código.
¿Preguntas sobre la API? Contáctanos.