Pour les développeurs

API pour les clubs

Version 1. Le serveur du site de votre club peut afficher les tournois du club et envoyer des inscriptions de joueurs au club. Cette page liste chaque appel, champ et erreur, et ce que l'API ne fait pas.

À quoi elle sert

Un club de poker gère ses tournois dans LynxPoker. Avec une clé API du club, le site du club peut afficher ces tournois et laisser les joueurs s'y inscrire depuis le site.

Une inscription depuis le site n'assoit jamais le joueur et n'encaisse jamais de paiement. Elle attend dans LynxPoker que l'équipe du club assoie le joueur ou refuse l'inscription.

Avant de commencer

  • Seul le propriétaire du club peut créer une clé, dans l'application web LynxPoker, sous Paramètres puis Clés API. Le propriétaire choisit un nom et ce que la clé peut faire. Un club peut avoir jusqu'à 20 clés actives.
  • Une clé a besoin d'une formule. Un club en essai gratuit ne peut pas en créer. Toute formule compte, quelle que soit la façon dont le club la paie, et aussi une formule que nous avons offerte au club. Si le paiement par carte du club échoue, ses clés continuent de marcher pendant que le paiement est retenté. Dès que l'abonnement est impayé, ou que la formule prend fin, chaque appel avec ses clés est refusé avec 403 CLUB_API_NEEDS_PLAN. Nous gardons les clés, et elles remarchent dès l'appel suivant une fois que le club a une formule.
  • Nous n'affichons une clé qu'une seule fois, à sa création. Si elle est perdue, le propriétaire la révoque et en crée une nouvelle. Une clé révoquée cesse de fonctionner tout de suite et ne peut pas être réactivée.
  • Appelez l'API uniquement depuis votre serveur. La clé est un secret : ne la mettez jamais dans une page web, une application mobile ou un dépôt de code public. Un appel qui porte l'en-tête Origin d'un navigateur sur votre site est refusé avec 403 CLUB_API_BROWSER_BLOCKED. Si votre serveur nous transmet la requête d'un visiteur, ne recopiez pas les en-têtes du navigateur.

Clés et réponses

Chaque appel va à cette adresse. Les chemins de cette page commencent par /api.

https://api.lynx.poker

Envoyez la clé dans l'en-tête Authorization de chaque appel, après le mot ClubKey et une espace :

Authorization: ClubKey <keyId>.<secret>

Une clé, c'est deux parties reliées par un point : l'identifiant de la clé et le secret. Envoyez-la exactement telle que vous l'avez copiée.

Ce qu'une clé peut faire

Le propriétaire le choisit en créant la clé. Un appel qui demande un accès que la clé n'a pas est refusé avec 403.

Ce qu'une clé peut faire
AccèsNom dans l'applicationAppels
TOURNAMENTS_READLire les tournoisGET /api/club-api/v1/tournaments
GET /api/club-api/v1/tournaments/:id
REGISTRATIONS_CREATEEnvoyer des inscriptionsPOST /api/club-api/v1/tournaments/:id/registrations

Réponses

Chaque réponse est en JSON. Une réponse réussie place ses données dans body. Son champ status indique toujours 200, alors lisez plutôt le statut HTTP : 200 pour une lecture, 201 pour une inscription.

Une réponse d'erreur a le statut HTTP, un message pour les personnes et, pour la plupart des erreurs, un errorCode. Lisez le statut HTTP et errorCode, jamais le message : les messages peuvent changer.

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"
}

Appels

Lister les tournois du club

GET/api/club-api/v1/tournaments

Accès requis: TOURNAMENTS_READ

Renvoie les tournois en cours ou en pause maintenant, puis ceux qui n'ont pas commencé et sont prévus dans les 30 prochains jours. Un tournoi qui n'a pas commencé reste dans la liste 6 heures après son début prévu. La liste en compte au plus 200 : ceux en direct d'abord, puis par début prévu. Un tournoi pas encore commencé n'est listé que s'il a un début prévu. Les tournois terminés ne sont jamais listés : lisez-en un par son identifiant.

Les tournois masqués aux joueurs et le tournoi d'entraînement du club ne sont jamais listés.

Chaque élément est le résumé que montre l'app des joueurs LynxPoker : le buy-in, le début, l'heure de fin des inscriptions tardives, et la taille du field et le prize pool quand le club les affiche. serverTime est notre horloge, pour corriger la vôtre.

Exemple de requête
curl https://api.lynx.poker/api/club-api/v1/tournaments \
  -H "Authorization: ClubKey $LYNX_CLUB_KEY"
Exemple de réponse
{
  "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"
  }
}

Erreurs que cet appel peut renvoyer: 401, 403, 429, 500, 503

Obtenir un tournoi

GET/api/club-api/v1/tournaments/:id

Accès requis: TOURNAMENTS_READ

Renvoie un tournoi de votre club, dans n'importe quel état, même après sa fin. Il a tous les champs d'un élément de la liste, plus les niveaux de blindes, les prix, et les joueurs quand le club affiche leurs noms. Il suit les réglages du club pour l'app des joueurs, donc il ne montre que ce que voient les joueurs.

lateRegClosed vaut true dès que les inscriptions sont fermées : une inscription répond alors 409 APP_REG_CLOSED. appRegistrationEnabled vaut false quand l'app des joueurs ne prend pas d'inscriptions pour ce tournoi. Ce peut être un choix du club pour l'app des joueurs seulement, ou des inscriptions coupées pour ce tournoi, ce qui refuse aussi vos inscriptions avec 403 APP_REG_DISABLED. appRegistrationLimit est le nombre maximum d'inscriptions que le tournoi accepte, depuis l'app des joueurs et votre site ensemble, et null veut dire sans limite. Aucun champ ne promet qu'une inscription passera : c'est la réponse à l'inscription qui décide.

Exemple de requête
curl https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10 \
  -H "Authorization: ClubKey $LYNX_CLUB_KEY"
Exemple de réponse
{
  "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
  }
}

Raccourcie : la vraie réponse a aussi tous les champs d'un élément de la liste. <fields>Champs des réponses</fields> liste tous les champs.

Erreurs que cet appel peut renvoyer: 401, 403, 404, 429, 500, 503

Envoyer une inscription

POST/api/club-api/v1/tournaments/:id/registrations

Accès requis: REGISTRATIONS_CREATE

Demande à inscrire un joueur à un tournoi. Envoyez l'identifiant du joueur dans la liste des joueurs du club, ou le nom du joueur avec un téléphone, un e-mail ou les deux. Jamais les deux façons dans le même appel.

Envoyer une inscription
ChampTypeObligatoireRègles
playerIdstringEnvoyez celui-ci, ou nameL'identifiant d'un joueur de la liste des joueurs de votre club. 64 caractères au plus.
namestringOui, sans playerIdLe nom du joueur. Pas vide, 120 caractères au plus.
phonestringUn téléphone, un e-mail ou les deux, sans playerId32 caractères au plus. Voir les règles du téléphone plus bas.
emailstringUn téléphone, un e-mail ou les deux, sans playerIdUne adresse e-mail valide, 254 caractères au plus.

N'envoyez que ces champs : tout autre champ est refusé avec 400. Un champ envoyé à null compte comme non envoyé.

Exemple de requête
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]"}'
Avec un identifiant de la liste
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 réponse est 201 avec l'inscription. Son status est toujours PENDING. createdPlayer vaut true quand cet appel a ajouté le joueur à la liste des joueurs du club.

Exemple de réponse
HTTP/1.1 201 Created

{
  "status": 200,
  "body": {
    "registrationId": "7d0c2f4e-8b1a-4e5f-a3c6-91b2d4e6f8a0",
    "status": "PENDING",
    "playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e",
    "createdPlayer": true
  }
}

Erreurs que cet appel peut renvoyer: 400, 401, 403, 404, 409, 413, 429, 500, 503

Comment nous trouvons le joueur

Avec playerId, nous utilisons ce joueur. Il doit être dans la liste des joueurs de votre club, sinon la réponse est 404.

Avec un nom, nous cherchons parmi les joueurs de votre club le même numéro de téléphone ou le même e-mail. Un e-mail correspond quelles que soient ses majuscules. Le nom ne sert jamais à trouver quelqu'un.

Si plusieurs joueurs correspondent, nous prenons celui qui a le même téléphone et le même e-mail, puis le même téléphone, puis le même e-mail. À égalité, nous prenons celui que l'équipe a modifié en dernier.

Si nous trouvons le joueur, nous l'utilisons sans rien changer à ses informations. Sinon, nous ajoutons un nouveau joueur à la liste des joueurs du club avec le nom, le téléphone et l'e-mail que vous avez envoyés.

Un numéro sans + est lu comme un numéro du pays du club, ou d'Israël quand le club n'a pas de pays. Pour un numéro d'un autre pays, commencez par + et l'indicatif du pays. Un numéro non valide est refusé avec 400.

Un faux numéro, dont les 7 derniers chiffres sont tous les mêmes, comme 050-0000000, est refusé avec 400 sauf si vous envoyez aussi un e-mail. Nous trouvons alors le joueur par l'e-mail.

Renvoyer la même inscription pendant qu'elle attend renvoie la même inscription, avec le même registrationId, et ne change rien. Vous pouvez donc relancer sans risque un appel resté sans réponse. Cela ne vaut que tant que les inscriptions sont ouvertes : une fois fermées, une relance répond 409 APP_REG_CLOSED, et une fois les inscriptions coupées pour le tournoi, 403 APP_REG_DISABLED.

Ce qui se passe ensuite

L'inscription apparaît dans la liste Joueurs inscrits du tournoi dans LynxPoker, marquée Depuis le site, et l'équipe reçoit la même alerte que pour une inscription depuis l'app des joueurs. À l'accueil, l'équipe assoit le joueur ou refuse l'inscription.

L'API ne peut pas dire à votre site ce que l'équipe a décidé. Aucun appel ne lit une inscription, et nous n'envoyons pas de webhooks. Si le joueur utilise l'app des joueurs LynxPoker et est relié au club, l'app le prévient quand il est assis.

Relancer l'appel ne sert pas à vérifier. Une fois le joueur assis ou sur la liste d'attente, une relance répond 409 APP_REG_ALREADY_ENTERED. Après un refus de l'équipe, ou une fois le joueur éliminé ou retiré, une relance envoie une nouvelle inscription.

Champs des réponses

Tous les champs que nos réponses peuvent contenir, d'après la définition de l'API elle-même. Le sens d'un champ est donné quand son nom ne le dit pas.

Les heures sont du texte en UTC, comme 2026-11-12T18:00:00.000Z. Un champ dont le nom finit par Timestamp est un nombre de millisecondes depuis le 1er janvier 1970, en UTC. Les montants sont des nombres simples, sans devise.

Un champ marqué « quand il y a lieu » est absent de la réponse quand il n'y a pas lieu. null n'apparaît que dans un champ dont le type le prévoit.

list

La réponse à l'appel de la liste.

Place dans la réponse: body

list
ChampTypeEnvoyéSens
itemstournament[]Toujours
serverTimestring (date-time)ToujoursNotre horloge au moment de répondre, pour corriger la vôtre.

tournament

Un tournoi : chaque élément de la liste, et le début de la réponse détaillée.

Place dans la réponse: body.items[] · body

tournament
ChampTypeEnvoyéSens
idstringToujoursL'identifiant du tournoi, pour les appels de détail et d'inscription.
organizationIdstringToujoursL'identifiant de votre club.
timeFormat"12h" | "24h"ToujoursComment le club écrit les heures : sur 12 ou sur 24 heures.
dateFormat"dmy" | "mdy"ToujoursComment le club écrit les dates : le jour d'abord (dmy) ou le mois d'abord (mdy).
titlestringToujours
descriptionstring | nullToujours
game"Holdem" | "Omaha"Toujours
type"Regular" | "Mystery" | "Bounty" | "Progressive" | "Satellite"Toujours
format"ReEntry" | "Freezeout" | "Rebuy"Toujours
scheduledStartAtstring (date-time) | nullToujoursLe début prévu. null dès que le jeu commence.
startingTimestring (date-time) | nullToujoursQuand le jeu a commencé. null avant.
gameStatusgameStatusToujours
settingssettingsToujours
infoinfoToujours
levelDurationMinutesnumber | nullToujoursLa durée du niveau en cours, ou du premier niveau avant le début du jeu.
lateRegLevelnumber | nullToujoursLe dernier niveau où un joueur peut encore entrer, compté depuis le niveau 1. null quand il n'y a pas d'inscriptions tardives.
lateRegCloseAtstring (date-time) | nullToujoursQuand les inscriptions tardives ferment, quand une heure s'applique.
lateRegClosedbooleanToujourstrue dès que les inscriptions sont fermées. Une inscription répond alors 409 APP_REG_CLOSED.
eventIdstringQuand il y a lieuL'événement dont ce tournoi est un jour. Envoyé seulement pour un jour d'un événement sur plusieurs jours, avec les trois champs suivants.
dayLabelstringQuand il y a lieuLe nom du jour tel que le club l'a écrit, comme Day 1A ou Day 2.
dayKind"FLIGHT" | "ONLINE" | "DAY"Quand il y a lieuFLIGHT est un flight du Day 1, ONLINE un Day 1 dont l'équipe saisit les entrées, sans horloge, et DAY le Day 2 ou après.
dayStepnumberQuand il y a lieu1 pour les flights du Day 1, 2 pour le Day 2, et ainsi de suite.
buyInPartWord"RAKE" | "FEE" | "CUSTOM"Quand il y a lieuLe mot du club pour la part de la maison dans le buy-in. Absent quand c'est RAKE.
buyInPartCustomstringQuand il y a lieuLe mot propre au club, quand buyInPartWord vaut CUSTOM.

detail

Les champs que seule la réponse détaillée contient, après ceux d'un élément de la liste.

Place dans la réponse: body

detail
ChampTypeEnvoyéSens
levelslevel[]Toujours
prizesprize[]ToujoursVide sauf si le club affiche les prix.
playersplayer[]Quand il y a lieuEnvoyé seulement quand le club affiche les noms des joueurs.
lastUpdatedAtstring (date-time)ToujoursLa dernière fois que le tournoi a changé.
serverTimestring (date-time)ToujoursNotre horloge au moment de répondre, pour corriger la vôtre.
registeredCountnumberQuand il y a lieuLes inscriptions en attente, assises ou sur la liste d'attente. Absent quand le club masque les noms des joueurs.
clockLayoutclockLayoutQuand il y a lieu
clockStyle"classic" | "dial"Quand il y a lieuLe style d'horloge du club dans l'app des joueurs. Un site peut l'ignorer.
clockValueOptionsclockValueOptionsQuand il y a lieu
pendingRegistrationCountnumberQuand il y a lieuLes inscriptions qui attendent l'équipe. Absent quand le club masque la taille du field.
appRegistrationEnabledbooleanToujoursSi l'app des joueurs prend des inscriptions pour ce tournoi maintenant. Voir l'appel de détail plus haut pour ce que false veut dire pour vos inscriptions.
appRegistrationLimitnumber | nullToujoursLe nombre maximum d'inscriptions que le tournoi accepte, depuis l'app des joueurs et votre site ensemble. null veut dire sans limite.
structureEstimatestructureEstimate | nullQuand il y a lieuEnvoyé seulement quand le club l'a activé, et seulement une fois les inscriptions tardives fermées.

gameStatus

L'état de l'horloge du tournoi.

Place dans la réponse: gameStatus

gameStatus
ChampTypeEnvoyéSens
position"Created" | "Running" | "Paused" | "Finished"ToujoursCreated : pas commencé. Running ou Paused : en jeu. Finished : terminé.
currentLevelUuidstring | nullToujoursLe niveau en cours, sous la forme du uuid d'un des niveaux.
currentLevelStartTimestampnumber | nullToujours
unTouchedCurrentLevelStartTimestampnumber | nullToujours
currentLevelPauseStartTimestampnumber | nullToujours
startTimestampnumber | nullToujours
endTimestampnumber | nullToujours
totalRunningTimeMsnumberQuand il y a lieu
tablesnumber[]ToujoursLes numéros des tables en jeu. Vide quand le club n'affiche pas les sièges.
handForHandhandForHandQuand il y a lieu
lastHandslastHandsQuand il y a lieu

handForHand

Envoyé seulement pendant que les tables jouent main par main, et que le tournoi est en cours ou en pause.

Place dans la réponse: gameStatus.handForHand

handForHand
ChampTypeEnvoyéSens
onbooleanToujours
handnumberToujours

lastHands

Envoyé seulement pendant que les dernières mains se jouent, et que le tournoi est en cours ou en pause.

Place dans la réponse: gameStatus.lastHands

lastHands
ChampTypeEnvoyéSens
totalnumberToujours
currentnumberToujours

settings

Les réglages du tournoi que les joueurs voient.

Place dans la réponse: settings

settings
ChampTypeEnvoyéSens
buyInnumberToujoursLe prix complet d'une entrée. Le rake et tout bounty sont dedans, jamais ajoutés.
rakenumberToujoursLa part de la maison dans buyIn.
reEntryPricenumber | nullQuand il y a lieuLe prix d'un re-entry ou d'une recave, ou null quand il n'y en a pas.
bountynumber | nullToujoursLa part du bounty dans buyIn, ou null quand il n'y en a pas.
startingStacknumberToujours
guaranteenumber | nullToujours
reEntryLimitnumber | nullToujours
format"ReEntry" | "Freezeout" | "Rebuy"Toujours
seatsPerTablenumberQuand il y a lieu
isDisplayPrizesbooleanToujourstrue quand le club affiche les prix. Quand c'est false, prizes est vide et info n'a pas de pools.
isDisplayPotLimitBetRangebooleanToujours
startingLevelUuidstring | nullQuand il y a lieu
startingRemainingMsnumber | nullQuand il y a lieu
showReEntriesbooleanToujours
showTotalChipsbooleanToujours
showAddOnsbooleanToujours
rebuyStackLimitnumber | nullQuand il y a lieu
addOnaddOn | nullQuand il y a lieuL'add-on, ou null quand le tournoi n'en a pas.
showSeatsbooleanToujoursfalse quand le club n'affiche pas qui est assis où. La table et le siège de chaque joueur valent alors null.
isAnnouncementbooleanToujours
announcementstringToujours
colorstring | nullToujoursLa couleur d'horloge choisie par le club, en couleur hex, ou null.

addOn

L'add-on, tant que le tournoi en a un.

Place dans la réponse: settings.addOn

addOn
ChampTypeEnvoyéSens
afterLevelnumberToujoursVendu à la pause après ce niveau.
buyInnumberToujoursSon prix complet, rake compris.
stacknumberToujours

info

Le field et le prize pool. Les nombres sont absents quand le club masque ses joueurs, et les pools quand il masque les prix. Les champs de satellite valent null sur un tournoi qui n'est pas un satellite.

Place dans la réponse: info

info
ChampTypeEnvoyéSens
bountyPoolnumberQuand il y a lieu
activePlayersnumberQuand il y a lieu
aggregateEntriesnumberQuand il y a lieu
aggregateReEntriesnumberQuand il y a lieu
theoreticalTotalChipsnumberQuand il y a lieu
aggregateAddOnsnumberQuand il y a lieu
totalPrizePoolnumberQuand il y a lieu
satelliteSeatsnumber | nullQuand il y a lieu
satelliteSeatMode"GUARANTEED" | "AUTO" | nullQuand il y a lieu
satelliteTargetStacknumber | nullQuand il y a lieu
satelliteQualifiednumber | nullQuand il y a lieu
qualifiedStackTotalnumber | nullQuand il y a lieu

level

Un niveau de blindes ou une pause, dans l'ordre du jeu.

Place dans la réponse: levels[]

level
ChampTypeEnvoyéSens
lengthInMinuetsnumberToujoursLa durée du niveau en minutes. Le nom du champ s'écrit bien ainsi.
innumberToujoursLa petite blinde.
outnumberToujoursLa grosse blinde.
antenumberToujours
isBreakbooleanToujours
ordernumberToujours
orderWithBreaksnumberToujours
uuidstringToujoursL'identifiant du niveau, comme dans gameStatus.currentLevelUuid.

prize

Une place de la liste des prix. La liste est vide sauf si le club affiche les prix.

Place dans la réponse: prizes[]

prize
ChampTypeEnvoyéSens
placenumberToujours
prizeAmountnumber | nullToujours
prizePercentagenumberToujours
prizeType"cash" | "seat"Quand il y a lieuseat quand le prix est un ticket pour un autre tournoi.
seatLabelstring | nullQuand il y a lieu

player

Un joueur. Envoyé seulement quand le club affiche les noms des joueurs.

Place dans la réponse: players[]

player
ChampTypeEnvoyéSens
namestringToujours
entriesnumberToujours
bustedbooleanToujourstrue dès que le joueur est éliminé.
qualifiedbooleanToujourstrue quand le joueur a gagné un ticket dans un satellite.
chipsnumber | nullQuand il y a lieuLes jetons du joueur, ou null quand le club n'affiche pas les jetons.
placednumber | nullQuand il y a lieuLe classement final du joueur, quand le club affiche les classements.
placedTonumberQuand il y a lieuLa fin d'une place partagée : placed 22 et placedTo 23 veut dire 22e à 23e.
payoutnumberQuand il y a lieuLes gains du joueur. Envoyé seulement quand le club affiche les classements et les prix.
knockoutsnumberQuand il y a lieu
rebuysnumberToujours
addOnsnumberToujours
tableNumbernumber | nullToujoursnull quand le joueur n'a pas de siège, ou que le club n'affiche pas les sièges.
seatNumbernumber | nullToujoursnull quand le joueur n'a pas de siège, ou que le club n'affiche pas les sièges.

structureEstimate

À peu près quand le tournoi finit, sous forme de fourchette.

Place dans la réponse: structureEstimate

structureEstimate
ChampTypeEnvoyéSens
loMinnumberToujoursLe bas de la fourchette, en minutes depuis le début.
hiMinnumberToujoursLe haut de la fourchette, en minutes depuis le début.
loAtstring (date-time) | nullToujoursLe bas de la fourchette sous forme d'heure, quand le début est connu.
hiAtstring (date-time) | nullToujoursLe haut de la fourchette sous forme d'heure, quand le début est connu.

clockLayout

L'aspect de l'écran d'horloge du club dans l'app des joueurs, avec les trois tableaux suivants. Un site peut les ignorer.

Place dans la réponse: clockLayout

clockLayout
ChampTypeEnvoyéSens
openclockStateToujours
closedclockStateToujours

clockState

Partie de la disposition de l'horloge : l'horloge pendant que les inscriptions sont ouvertes, et une fois fermées.

Place dans la réponse: clockLayout.open · clockLayout.closed

clockState
ChampTypeEnvoyéSens
leftclockSideToujours
rightclockSideToujours

clockSide

Partie de la disposition de l'horloge : ce qu'affiche un côté de l'horloge.

Place dans la réponse: clockLayout.*.left · clockLayout.*.right

clockSide
ChampTypeEnvoyéSens
mode"list" | "thirds"Toujours
values("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[]Quand il y a lieu
top("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[]Quand il y a lieu
middle("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[]Quand il y a lieu
bottom("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[]Quand il y a lieu

clockValueOptions

Partie de la disposition de l'horloge : comment certaines valeurs s'écrivent sur l'horloge.

Place dans la réponse: clockValueOptions

clockValueOptions
ChampTypeEnvoyéSens
buyInSplitbooleanToujours
lateRegFormat"level" | "time"Toujours
prizeListMotion"pages" | "bounce" | "loop"Toujours
avgStackInBbbooleanToujours
startingStackInBbbooleanToujours

registration

La réponse à une inscription.

Place dans la réponse: body

registration
ChampTypeEnvoyéSens
registrationIdstringToujoursL'identifiant de l'inscription.
status"PENDING"ToujoursToujours PENDING : l'inscription attend l'équipe.
playerIdstringToujoursL'identifiant du joueur dans la liste des joueurs de votre club. Envoyez-le comme playerId la prochaine fois.
createdPlayerbooleanToujourstrue quand cet appel a ajouté le joueur à la liste des joueurs.

Ce que l'API ne fait pas

La version 1 ne propose rien de tout ceci :

  • Lister ou chercher les joueurs du club, ou lire le téléphone ou l'e-mail de quelqu'un. Les réponses ne contiennent aucune coordonnée.
  • Ajouter un joueur sans inscription, ou modifier les informations d'un joueur.
  • Lire, annuler ou modifier une inscription après son envoi.
  • Asseoir un joueur, encaisser un paiement ou enregistrer un buy-in.
  • Créer ou modifier un tournoi, ou modifier quoi que ce soit d'autre dans le club.
  • Lire l'argent du club : paiements ou recettes. Les prix, le prize pool et les gains de chaque joueur n'apparaissent que tels que les joueurs les voient, quand le club les affiche.
  • Parcourir la liste des tournois page par page ou la filtrer. Elle en compte au plus 200, sans page suivante.
  • Lister les tournois terminés ou passés. Lisez plutôt un tournoi terminé par son identifiant.
  • Voir les tournois masqués aux joueurs, ou le tournoi d'entraînement.
  • Être appelée depuis une page dans un navigateur. Un appel qui porte l'en-tête Origin d'un navigateur sur votre site est refusé.
  • Agir pour un autre club. Une clé lit et envoie des inscriptions pour son propre club seulement, et tout autre tournoi répond 404.
  • Créer, lister ou révoquer des clés. Seul le propriétaire le fait, dans l'application web.
  • Prévenir votre serveur quand quelque chose change. Il n'y a pas de webhooks : relisez la liste quand vous en avez besoin.

Limites et erreurs

Chaque clé peut faire 10 appels par seconde et 300 appels en 10 minutes, les trois appels comptés ensemble, et envoyer 200 nouvelles inscriptions sur toute période de 24 heures. Une inscription renvoyée après un refus de l'équipe compte comme nouvelle. Relancer une inscription qui attend encore ne compte pas dans les 200. En plus, les appels d'une même adresse IP sont limités pour chacun des trois appels : 30 par seconde, 150 en 10 secondes et 600 par minute, quelles que soient les clés utilisées.

Limites et erreurs
StatuterrorCodeCe que ça veut direQue faire
400–Le corps est incorrect : ce n'est pas du JSON valide, un champ manque, est vide, trop long ou n'est pas permis, l'e-mail n'est pas valide, les deux façons ont été envoyées, un nom est venu sans téléphone ni e-mail, ou le téléphone n'est pas valide ou est un faux numéro.Corrigez la requête. Le message dit ce qui ne va pas.
401–La clé manque, n'est pas envoyée avec ClubKey et une espace devant, est fausse ou révoquée.Vérifiez la clé. Si elle a été révoquée, demandez-en une nouvelle au propriétaire du club.
403CLUB_API_NEEDS_PLANLe club n'a pas de formule : il est en essai gratuit, sa formule a pris fin, ou son abonnement est impayé.Demandez au club de choisir une formule. La clé remarche dès qu'il l'a fait.
403–La clé n'a pas l'accès dont cet appel a besoin.Demandez au propriétaire une clé avec cet accès.
403CLUB_API_BROWSER_BLOCKEDL'appel portait l'en-tête Origin d'un navigateur sur votre site. Les appels viennent uniquement de votre serveur.Appelez depuis votre serveur, sans en-tête Origin.
403APP_REG_DISABLEDLes inscriptions sont coupées pour ce tournoi, ou ce joueur ne peut pas s'inscrire dans ce club.Ne réessayez pas. Dites au joueur de contacter le club.
404–Le tournoi n'est pas un tournoi que votre clé peut voir (d'un autre club, masqué aux joueurs, celui d'entraînement, ou un identifiant qui n'existe pas), ou le joueur n'est pas dans la liste des joueurs du club.Vérifiez l'identifiant, et relisez la liste des tournois.
409APP_REG_CLOSEDLes inscriptions à ce tournoi sont fermées : les inscriptions tardives sont finies, l'équipe a fermé les inscriptions, le dernier niveau est fini pendant que l'équipe règle les résultats, ou le tournoi est terminé.Ne réessayez pas. Arrêtez de proposer l'inscription à ce tournoi.
409APP_REG_CAP_FULLLe tournoi a atteint sa limite d'inscriptions, indiquée dans details.limit.Ne réessayez pas, sauf si une place se libère.
409APP_REG_ALREADY_ENTEREDLe joueur joue déjà ce tournoi.Rien : le joueur est dedans.
409TOURNAMENT_BUSYQuelqu'un a enregistré ce tournoi au même moment. Rien n'a changé.Réessayez dans un instant.
413PAYLOAD_TOO_LARGELe corps dépasse 100 kB.N'envoyez que les champs de cette page.
429CLUB_KEY_DAILY_SIGNUP_LIMITLa clé a envoyé 200 nouvelles inscriptions ces dernières 24 heures, la limite indiquée dans details.limit.Attendez les secondes de l'en-tête Retry-After, aussi dans details.retryAfterSeconds : d'ici là, une inscription sera sortie des 24 heures.
429–Trop d'appels : plus de 10 par seconde ou 300 en 10 minutes pour cette clé, ou au-delà des limites de votre adresse IP. Au-delà de 300 appels, la clé est refusée jusqu'à 10 minutes.Attendez les secondes de l'en-tête Retry-After, puis appelez moins souvent. Les limites par adresse IP envoient plutôt Retry-After-short, Retry-After-medium ou Retry-After-long.
500INTERNAL_ERRORQuelque chose a échoué chez nous.Réessayez après une courte attente. Relancer une inscription est sans risque.
503DB_STATEMENT_TIMEOUTNotre base de données a mis trop de temps à répondre. Rien n'a changé.Réessayez après une courte attente.

Changements

C'est la version 1, nommée v1 dans chaque chemin. Nous ne faisons qu'y ajouter : de nouveaux champs dans les réponses, jamais un champ retiré ou renommé. Ignorez les champs que vous ne connaissez pas, ainsi un nouveau champ ne casse jamais votre code.

Des questions sur l'API ? Contactez-nous.