API למועדונים
גרסה 1. השרת של אתר המועדון יכול להציג את הטורנירים של המועדון ולשלוח אליו הרשמות של שחקנים. בעמוד הזה כל קריאה, כל שדה וכל שגיאה, וגם מה ה-API לא יכול לעשות.
בשביל מה זה
מועדון פוקר מנהל את הטורנירים שלו ב-LynxPoker. עם מפתח API של המועדון, האתר של המועדון יכול להציג את הטורנירים האלה ולתת לשחקנים להירשם אליהם דרכו.
הרשמה מהאתר אף פעם לא מושיבה שחקן ואף פעם לא גובה תשלום. היא מחכה ב-LynxPoker עד שהצוות של המועדון מושיב את השחקן או דוחה את ההרשמה.
לפני שמתחילים
- רק הבעלים של המועדון יכול ליצור מפתח, באפליקציית הווב של LynxPoker, תחת הגדרות ואז מפתחות API. הבעלים בוחר שם ומה המפתח רשאי לעשות. למועדון יכולים להיות עד 20 מפתחות פעילים.
- מפתח צריך תוכנית. מועדון בתקופת הניסיון החינמית לא יכול ליצור מפתח. כל תוכנית נחשבת, לא משנה איך המועדון משלם עליה, וגם תוכנית שנתנו למועדון. אם התשלום בכרטיס של המועדון נכשל, המפתחות שלו ממשיכים לעבוד בזמן שהתשלום מנוסה שוב. ברגע שהמנוי לא שולם, או שהתוכנית מסתיימת, כל קריאה עם המפתחות שלו נדחית עם
403CLUB_API_NEEDS_PLAN. אנחנו שומרים את המפתחות, והם עובדים שוב מהקריאה הבאה ברגע שיש למועדון תוכנית. - אנחנו מציגים מפתח פעם אחת בלבד, כשהוא נוצר. אם הוא אבד, הבעלים מבטל אותו ויוצר חדש. מפתח שבוטל מפסיק לעבוד מיד, ואי אפשר להפעיל אותו שוב.
- קראו ל-API רק מהשרת שלכם. המפתח הוא סוד: לעולם אל תשימו אותו בעמוד אינטרנט, באפליקציה לנייד או במאגר קוד ציבורי. קריאה שנושאת כותרת
Originשל דפדפן מהאתר שלכם נדחית עם403CLUB_API_BROWSER_BLOCKED. אם השרת שלכם מעביר אלינו בקשה של מבקר, אל תעתיקו את הכותרות של הדפדפן.
מפתחות ותשובות
כל קריאה נשלחת לכתובת הזו. הנתיבים בעמוד הזה מתחילים ב-/api.
https://api.lynx.pokerשלחו את המפתח בכותרת Authorization של כל קריאה, אחרי המילה ClubKey ורווח:
Authorization: ClubKey <keyId>.<secret>מפתח הוא שני חלקים שמחוברים בנקודה: מזהה המפתח והסוד. שלחו אותו בדיוק כפי שהעתקתם אותו.
מה מפתח רשאי לעשות
הבעלים בוחר את זה כשהוא יוצר את המפתח. קריאה שצריכה הרשאה שאין למפתח נדחית עם 403.
| הרשאה | השם באפליקציה | קריאות |
|---|---|---|
TOURNAMENTS_READ | קריאת טורנירים | GET /api/club-api/v1/tournaments GET /api/club-api/v1/tournaments/:id |
REGISTRATIONS_CREATE | שליחת הרשמות | POST /api/club-api/v1/tournaments/:id/registrations |
תשובות
כל תשובה היא JSON. תשובה מוצלחת מחזיקה את הנתונים שלה ב-body. השדה status שלה תמיד 200, אז קראו את סטטוס ה-HTTP במקומו: 200 לקריאת נתונים, 201 להרשמה.
בתשובת שגיאה יש את סטטוס ה-HTTP, message לבני אדם, וברוב השגיאות גם errorCode. קראו את סטטוס ה-HTTP ואת errorCode, אף פעם לא את ההודעה: הודעות יכולות להשתנות.
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"
}קריאות
רשימת הטורנירים של המועדון
GET/api/club-api/v1/tournaments
ההרשאה הנדרשת: TOURNAMENTS_READ
מחזירה את הטורנירים שרצים או בהפסקה עכשיו, ואחריהם את אלה שעוד לא התחילו ומתוכננים ל-30 הימים הקרובים. טורניר שלא התחיל נשאר ברשימה 6 שעות אחרי שעת ההתחלה המתוכננת. ברשימה יש עד 200: קודם החיים, ואז לפי שעת ההתחלה המתוכננת. טורניר שעוד לא התחיל מופיע ברשימה רק כשיש לו שעת התחלה מתוכננת. טורנירים שהסתיימו אף פעם לא מופיעים ברשימה: קראו אחד מהם לפי ה-ID שלו.
טורנירים שמוסתרים מהשחקנים וטורניר התרגול של המועדון אף פעם לא מופיעים ברשימה.
כל פריט הוא הסיכום שאפליקציית השחקנים של LynxPoker מציגה: הבאי-אין, ההתחלה, מתי ההרשמה המאוחרת נסגרת, וגודל השדה והפרייז פול כשהמועדון מציג אותם. serverTime הוא השעון שלנו, כדי שתוכלו לתקן את שלכם.
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"
}
}שגיאות שהקריאה הזו יכולה להחזיר: 401, 403, 429, 500, 503
טורניר אחד
GET/api/club-api/v1/tournaments/:id
ההרשאה הנדרשת: TOURNAMENTS_READ
מחזירה טורניר אחד של המועדון שלכם, בכל מצב, גם אחרי שהוא נגמר. יש בה כל שדה של פריט ברשימה, ובנוסף שלבי הבליינדים, הפרסים, והשחקנים כשהמועדון מציג את השמות שלהם. היא פועלת לפי ההגדרות של המועדון לאפליקציית השחקנים, אז היא מציגה רק מה שהשחקנים רואים.
lateRegClosed הוא true ברגע שההרשמה סגורה: הרשמה עונה אז 409 APP_REG_CLOSED. appRegistrationEnabled הוא false כשאפליקציית השחקנים לא מקבלת הרשמות לטורניר הזה. זו יכולה להיות בחירה של המועדון לגבי אפליקציית השחקנים בלבד, או שההרשמות לטורניר הזה כבויות, ואז גם ההרשמות שלכם נדחות עם 403 APP_REG_DISABLED. appRegistrationLimit הוא המספר המרבי של הרשמות שהטורניר מקבל, מאפליקציית השחקנים ומהאתר שלכם יחד, ו-null אומר שאין מגבלה. אף שדה לא מבטיח שהרשמה תעבור: התשובה להרשמה היא שקובעת.
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
}
}מקוצר: התשובה האמיתית כוללת גם כל שדה של פריט ברשימה. <fields>שדות התשובה</fields> מפרט כל שדה.
שגיאות שהקריאה הזו יכולה להחזיר: 401, 403, 404, 429, 500, 503
שליחת הרשמה
POST/api/club-api/v1/tournaments/:id/registrations
ההרשאה הנדרשת: REGISTRATIONS_CREATE
מבקשת לרשום שחקן אחד לטורניר אחד. שלחו את מזהה השחקן ברשימת השחקנים של המועדון, או את שם השחקן עם טלפון, אימייל או שניהם. אף פעם לא את שתי הדרכים באותה קריאה.
| שדה | סוג | חובה | כללים |
|---|---|---|---|
playerId | string | שלחו את זה, או name | המזהה של שחקן ברשימת השחקנים של המועדון שלכם. עד 64 תווים. |
name | string | כן, בלי playerId | שם השחקן. לא ריק, עד 120 תווים. |
phone | string | טלפון, אימייל או שניהם, בלי playerId | עד 32 תווים. ראו את כללי הטלפון בהמשך. |
email | string | טלפון, אימייל או שניהם, בלי playerId | כתובת אימייל תקינה, עד 254 תווים. |
שלחו רק את השדות האלה: כל שדה אחר נדחה עם 400. שדה שנשלח כ-null נחשב כאילו לא נשלח.
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"}'התשובה היא 201 עם ההרשמה. ה-status שלה תמיד PENDING. createdPlayer הוא true כשהקריאה הזו הוסיפה את השחקן לרשימת השחקנים של המועדון.
HTTP/1.1 201 Created
{
"status": 200,
"body": {
"registrationId": "7d0c2f4e-8b1a-4e5f-a3c6-91b2d4e6f8a0",
"status": "PENDING",
"playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e",
"createdPlayer": true
}
}שגיאות שהקריאה הזו יכולה להחזיר: 400, 401, 403, 404, 409, 413, 429, 500, 503
איך אנחנו מוצאים את השחקן
עם playerId, אנחנו משתמשים בשחקן הזה. הוא חייב להיות שחקן ברשימת השחקנים של המועדון שלכם, אחרת התשובה היא 404.
עם שם, אנחנו מחפשים בין השחקנים של המועדון שלכם את אותו מספר טלפון או את אותו אימייל. אימייל מתאים בלי קשר לאותיות גדולות וקטנות. השם אף פעם לא משמש כדי למצוא מישהו.
אם כמה שחקנים מתאימים, אנחנו לוקחים את מי שיש לו גם אותו טלפון וגם אותו אימייל, אחריו את מי שיש לו אותו טלפון, ואחריו את מי שיש לו אותו אימייל. בין שווים, אנחנו לוקחים את מי שהצוות עדכן אחרון.
אם מצאנו את השחקן, אנחנו משתמשים בו ולא משנים שום דבר בפרטים שלו. אם לא, אנחנו מוסיפים שחקן חדש לרשימת השחקנים של המועדון עם השם, הטלפון והאימייל ששלחתם.
מספר טלפון בלי + נקרא כמספר במדינה של המועדון, או בישראל כשלמועדון לא מוגדרת מדינה. למספר ממדינה אחרת, התחילו ב-+ ובקידומת המדינה. מספר לא תקין נדחה עם 400.
מספר ממלא מקום, כזה ש-7 הספרות האחרונות שלו כולן אותה ספרה, כמו 050-0000000, נדחה עם 400 אלא אם שולחים גם אימייל. אז אנחנו מוצאים את השחקן לפי האימייל.
שליחה חוזרת של אותה הרשמה בזמן שהיא מחכה מחזירה את אותה הרשמה, עם אותו registrationId, ולא משנה כלום. כך אפשר לנסות שוב בבטחה קריאה שלא קיבלה תשובה בזמן. זה נכון רק כל עוד ההרשמה פתוחה: ברגע שהיא סגורה, שליחה חוזרת עונה 409 APP_REG_CLOSED, וברגע שההרשמות לטורניר כבויות, 403 APP_REG_DISABLED.
מה קורה אחר כך
ההרשמה מופיעה ברשימת שחקנים רשומים של הטורניר ב-LynxPoker, עם הסימון מהאתר, והצוות מקבל את אותה התראה כמו על הרשמה מאפליקציית השחקנים. בקופה, הצוות מושיב את השחקן או דוחה את ההרשמה.
ה-API לא יכול לספר לאתר שלכם מה הצוות החליט. אין קריאה שקוראת הרשמה, ואנחנו לא שולחים webhooks. אם השחקן משתמש באפליקציית השחקנים של LynxPoker ומחובר למועדון, האפליקציה מודיעה לו כשהוא הושב.
קריאה חוזרת היא לא דרך לבדוק. אחרי שהשחקן הושב או נכנס לרשימת ההמתנה, קריאה חוזרת עונה 409 APP_REG_ALREADY_ENTERED. אחרי שהצוות דחה הרשמה, או אחרי שהשחקן הודח או הוסר, קריאה חוזרת שולחת הרשמה חדשה.
שדות התשובה
כל שדה שהתשובות שלנו יכולות לכלול, מתוך ההגדרה של ה-API עצמו. המשמעות של שדה מופיעה כשהשם שלו לא אומר אותה.
זמנים הם טקסט ב-UTC, למשל 2026-11-12T18:00:00.000Z. שדה שהשם שלו נגמר ב-Timestamp הוא מספר אלפיות השנייה מאז 1 בינואר 1970, ב-UTC. סכומי כסף הם מספרים פשוטים, בלי מטבע.
שדה שמסומן "כשרלוונטי" לא נכלל בתשובה כשהוא לא רלוונטי. null מופיע רק בשדה שהסוג שלו כולל אותו.
list
התשובה לקריאת הרשימה.
המקום בתשובה: body
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
items | tournament[] | תמיד | |
serverTime | string (date-time) | תמיד | השעון שלנו כשענינו, כדי שתוכלו לתקן את שלכם. |
tournament
טורניר אחד: כל פריט ברשימה, והחלק הראשון של תשובת הפרטים.
המקום בתשובה: body.items[] · body
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
id | string | תמיד | ה-ID של הטורניר, לקריאת הפרטים ולקריאת ההרשמה. |
organizationId | string | תמיד | ה-ID של המועדון שלכם. |
timeFormat | "12h" | "24h" | תמיד | איך המועדון כותב שעות: שעון של 12 שעות או של 24 שעות. |
dateFormat | "dmy" | "mdy" | תמיד | איך המועדון כותב תאריכים: היום קודם (dmy) או החודש קודם (mdy). |
title | string | תמיד | |
description | string | null | תמיד | |
game | "Holdem" | "Omaha" | תמיד | |
type | "Regular" | "Mystery" | "Bounty" | "Progressive" | "Satellite" | תמיד | |
format | "ReEntry" | "Freezeout" | "Rebuy" | תמיד | |
scheduledStartAt | string (date-time) | null | תמיד | שעת ההתחלה המתוכננת. null ברגע שהמשחק מתחיל. |
startingTime | string (date-time) | null | תמיד | מתי המשחק התחיל. null לפני כן. |
gameStatus | gameStatus | תמיד | |
settings | settings | תמיד | |
info | info | תמיד | |
levelDurationMinutes | number | null | תמיד | האורך של השלב שמשוחק עכשיו, או של השלב הראשון לפני שהמשחק מתחיל. |
lateRegLevel | number | null | תמיד | השלב האחרון שבו שחקן עוד יכול להיכנס, כשסופרים משלב 1. null כשאין הרשמה מאוחרת. |
lateRegCloseAt | string (date-time) | null | תמיד | מתי ההרשמה המאוחרת נסגרת, כשיש לזה שעה. |
lateRegClosed | boolean | תמיד | true ברגע שההרשמה סגורה. הרשמה עונה אז 409 APP_REG_CLOSED. |
eventId | string | כשרלוונטי | האירוע שהטורניר הזה הוא יום אחד שלו. נשלח רק ליום של אירוע מרובה ימים, יחד עם שלושת השדות הבאים. |
dayLabel | string | כשרלוונטי | השם של היום כפי שהמועדון כתב אותו, למשל Day 1A או Day 2. |
dayKind | "FLIGHT" | "ONLINE" | "DAY" | כשרלוונטי | FLIGHT הוא פלייט של Day 1, ONLINE הוא Day 1 שהצוות מקליד את הכניסות שלו, בלי שעון, ו-DAY הוא Day 2 ואילך. |
dayStep | number | כשרלוונטי | 1 לפלייטים של Day 1, 2 ל-Day 2, וכן הלאה. |
buyInPartWord | "RAKE" | "FEE" | "CUSTOM" | כשרלוונטי | המילה של המועדון לחלק של הבית בבאי-אין. לא נכלל כשהיא RAKE. |
buyInPartCustom | string | כשרלוונטי | המילה של המועדון עצמו, כש-buyInPartWord הוא CUSTOM. |
detail
השדות שרק בתשובת הפרטים, אחרי השדות של פריט ברשימה.
המקום בתשובה: body
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
levels | level[] | תמיד | |
prizes | prize[] | תמיד | ריק אלא אם המועדון מציג פרסים. |
players | player[] | כשרלוונטי | נשלח רק כשהמועדון מציג את שמות השחקנים. |
lastUpdatedAt | string (date-time) | תמיד | מתי הטורניר השתנה לאחרונה. |
serverTime | string (date-time) | תמיד | השעון שלנו כשענינו, כדי שתוכלו לתקן את שלכם. |
registeredCount | number | כשרלוונטי | הרשמות שמחכות, שהושבו או שברשימת ההמתנה. לא נכלל כשהמועדון מסתיר את שמות השחקנים. |
clockLayout | clockLayout | כשרלוונטי | |
clockStyle | "classic" | "dial" | כשרלוונטי | סגנון השעון של המועדון באפליקציית השחקנים. אתר יכול להתעלם ממנו. |
clockValueOptions | clockValueOptions | כשרלוונטי | |
pendingRegistrationCount | number | כשרלוונטי | הרשמות שמחכות לצוות. לא נכלל כשהמועדון מסתיר את גודל השדה. |
appRegistrationEnabled | boolean | תמיד | האם אפליקציית השחקנים מקבלת עכשיו הרשמות לטורניר הזה. מה false אומר להרשמות שלכם מוסבר בקריאת הפרטים למעלה. |
appRegistrationLimit | number | null | תמיד | המספר המרבי של הרשמות שהטורניר מקבל, מאפליקציית השחקנים ומהאתר שלכם יחד. null אומר שאין מגבלה. |
structureEstimate | structureEstimate | null | כשרלוונטי | נשלח רק כשהמועדון הפעיל אותו, ורק אחרי שההרשמה המאוחרת נסגרה. |
gameStatus
המצב של השעון של הטורניר.
המקום בתשובה: gameStatus
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
position | "Created" | "Running" | "Paused" | "Finished" | תמיד | Created: לא התחיל. Running או Paused: במשחק. Finished: נגמר. |
currentLevelUuid | string | null | תמיד | השלב שמשוחק עכשיו, כ-uuid של אחד השלבים. |
currentLevelStartTimestamp | number | null | תמיד | |
unTouchedCurrentLevelStartTimestamp | number | null | תמיד | |
currentLevelPauseStartTimestamp | number | null | תמיד | |
startTimestamp | number | null | תמיד | |
endTimestamp | number | null | תמיד | |
totalRunningTimeMs | number | כשרלוונטי | |
tables | number[] | תמיד | המספרים של השולחנות שבמשחק. ריק כשהמועדון לא מציג מושבים. |
handForHand | handForHand | כשרלוונטי | |
lastHands | lastHands | כשרלוונטי |
handForHand
נשלח רק בזמן שהשולחנות משחקים יד ביד, והטורניר רץ או בהפסקה.
המקום בתשובה: gameStatus.handForHand
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
on | boolean | תמיד | |
hand | number | תמיד |
lastHands
נשלח רק בזמן שמשחקים את הידיים האחרונות, והטורניר רץ או בהפסקה.
המקום בתשובה: gameStatus.lastHands
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
total | number | תמיד | |
current | number | תמיד |
settings
ההגדרות של הטורניר שהשחקנים רואים.
המקום בתשובה: settings
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
buyIn | number | תמיד | המחיר המלא של כניסה. הרייק וכל באונטי נמצאים בתוכו, אף פעם לא מתווספים אליו. |
rake | number | תמיד | החלק של הבית ב-buyIn. |
reEntryPrice | number | null | כשרלוונטי | המחיר של ריאנטרי או ריבאי, או null כשאין. |
bounty | number | null | תמיד | החלק של הבאונטי ב-buyIn, או null כשאין. |
startingStack | number | תמיד | |
guarantee | number | null | תמיד | |
reEntryLimit | number | null | תמיד | |
format | "ReEntry" | "Freezeout" | "Rebuy" | תמיד | |
seatsPerTable | number | כשרלוונטי | |
isDisplayPrizes | boolean | תמיד | true כשהמועדון מציג פרסים. כשהוא false, prizes ריק ואין קופות ב-info. |
isDisplayPotLimitBetRange | boolean | תמיד | |
startingLevelUuid | string | null | כשרלוונטי | |
startingRemainingMs | number | null | כשרלוונטי | |
showReEntries | boolean | תמיד | |
showTotalChips | boolean | תמיד | |
showAddOns | boolean | תמיד | |
rebuyStackLimit | number | null | כשרלוונטי | |
addOn | addOn | null | כשרלוונטי | האד-און, או null כשאין לטורניר אד-און. |
showSeats | boolean | תמיד | false כשהמועדון לא מציג מי יושב איפה. השולחן והמושב של כל שחקן הם אז null. |
isAnnouncement | boolean | תמיד | |
announcement | string | תמיד | |
color | string | null | תמיד | צבע השעון שהמועדון בחר, כצבע hex, או null. |
addOn
האד-און, כל עוד יש לטורניר אחד.
המקום בתשובה: settings.addOn
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
afterLevel | number | תמיד | נמכר בהפסקה שאחרי השלב הזה. |
buyIn | number | תמיד | המחיר המלא שלו, עם הרייק בתוכו. |
stack | number | תמיד |
info
השדה והפרייז פול. המספרים לא נכללים כשהמועדון מסתיר את השחקנים שלו, והקופות לא נכללות כשהוא מסתיר את הפרסים. שדות הסאטלייט הם null בטורניר שהוא לא סאטלייט.
המקום בתשובה: info
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
bountyPool | number | כשרלוונטי | |
activePlayers | number | כשרלוונטי | |
aggregateEntries | number | כשרלוונטי | |
aggregateReEntries | number | כשרלוונטי | |
theoreticalTotalChips | number | כשרלוונטי | |
aggregateAddOns | number | כשרלוונטי | |
totalPrizePool | number | כשרלוונטי | |
satelliteSeats | number | null | כשרלוונטי | |
satelliteSeatMode | "GUARANTEED" | "AUTO" | null | כשרלוונטי | |
satelliteTargetStack | number | null | כשרלוונטי | |
satelliteQualified | number | null | כשרלוונטי | |
qualifiedStackTotal | number | null | כשרלוונטי |
level
שלב בליינדים אחד או הפסקה, לפי סדר המשחק.
המקום בתשובה: levels[]
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
lengthInMinuets | number | תמיד | האורך של השלב בדקות. השם של השדה נכתב ככה. |
in | number | תמיד | הסמול בליינד. |
out | number | תמיד | הביג בליינד. |
ante | number | תמיד | |
isBreak | boolean | תמיד | |
order | number | תמיד | |
orderWithBreaks | number | תמיד | |
uuid | string | תמיד | ה-ID של השלב, כמו ב-gameStatus.currentLevelUuid. |
prize
מקום אחד ברשימת הפרסים. הרשימה ריקה אלא אם המועדון מציג פרסים.
המקום בתשובה: prizes[]
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
place | number | תמיד | |
prizeAmount | number | null | תמיד | |
prizePercentage | number | תמיד | |
prizeType | "cash" | "seat" | כשרלוונטי | seat כשהפרס הוא מושב בטורניר אחר. |
seatLabel | string | null | כשרלוונטי |
player
שחקן אחד. נשלח רק כשהמועדון מציג את שמות השחקנים.
המקום בתשובה: players[]
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
name | string | תמיד | |
entries | number | תמיד | |
busted | boolean | תמיד | true ברגע שהשחקן הודח. |
qualified | boolean | תמיד | true כשהשחקן זכה במושב בסאטלייט. |
chips | number | null | כשרלוונטי | הצ'יפים של השחקן, או null כשהמועדון לא מציג צ'יפים. |
placed | number | null | כשרלוונטי | המקום שבו השחקן סיים, כשהמועדון מציג מקומות. |
placedTo | number | כשרלוונטי | הסוף של מקום משותף: placed 22 ו-placedTo 23 הם מקומות 22 עד 23. |
payout | number | כשרלוונטי | כספי הפרס של השחקן. נשלח רק כשהמועדון מציג מקומות ופרסים. |
knockouts | number | כשרלוונטי | |
rebuys | number | תמיד | |
addOns | number | תמיד | |
tableNumber | number | null | תמיד | null כשאין לשחקן מושב, או כשהמועדון לא מציג מושבים. |
seatNumber | number | null | תמיד | null כשאין לשחקן מושב, או כשהמועדון לא מציג מושבים. |
structureEstimate
בערך מתי הטורניר ייגמר, כטווח.
המקום בתשובה: structureEstimate
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
loMin | number | תמיד | הקצה המוקדם של הטווח, בדקות מההתחלה. |
hiMin | number | תמיד | הקצה המאוחר של הטווח, בדקות מההתחלה. |
loAt | string (date-time) | null | תמיד | הקצה המוקדם כשעה, כששעת ההתחלה ידועה. |
hiAt | string (date-time) | null | תמיד | הקצה המאוחר כשעה, כששעת ההתחלה ידועה. |
clockLayout
איך מסך השעון של המועדון נראה באפליקציית השחקנים, יחד עם שלוש הטבלאות הבאות. אתר יכול להתעלם מהן.
המקום בתשובה: clockLayout
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
open | clockState | תמיד | |
closed | clockState | תמיד |
clockState
חלק מפריסת השעון: השעון בזמן שההרשמה פתוחה, ואחרי שהיא נסגרת.
המקום בתשובה: clockLayout.open · clockLayout.closed
clockSide
חלק מפריסת השעון: מה צד אחד של השעון מציג.
המקום בתשובה: clockLayout.*.left · clockLayout.*.right
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
mode | "list" | "thirds" | תמיד | |
values | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | כשרלוונטי | |
top | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | כשרלוונטי | |
middle | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | כשרלוונטי | |
bottom | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | כשרלוונטי |
clockValueOptions
חלק מפריסת השעון: איך כמה ערכים נכתבים על השעון.
המקום בתשובה: clockValueOptions
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
buyInSplit | boolean | תמיד | |
lateRegFormat | "level" | "time" | תמיד | |
prizeListMotion | "pages" | "bounce" | "loop" | תמיד | |
avgStackInBb | boolean | תמיד | |
startingStackInBb | boolean | תמיד |
registration
התשובה להרשמה.
המקום בתשובה: body
| שדה | סוג | נשלח | משמעות |
|---|---|---|---|
registrationId | string | תמיד | ה-ID של ההרשמה. |
status | "PENDING" | תמיד | תמיד PENDING: ההרשמה מחכה לצוות. |
playerId | string | תמיד | ה-ID של השחקן ברשימת השחקנים של המועדון שלכם. שלחו אותו כ-playerId בפעם הבאה. |
createdPlayer | boolean | תמיד | true כשהקריאה הזו הוסיפה את השחקן לרשימת השחקנים. |
מה ה-API לא יכול לעשות
בגרסה 1 אין אף אחד מאלה:
- להציג או לחפש את השחקנים של המועדון, או לקרוא טלפון או אימייל של מישהו. בתשובות אין פרטי קשר.
- להוסיף שחקן בלי הרשמה, או לשנות פרטים של שחקן.
- לקרוא, לבטל או לשנות הרשמה אחרי שנשלחה.
- להושיב שחקן, לגבות תשלום או לרשום באי-אין.
- ליצור או לשנות טורניר, או לשנות כל דבר אחר במועדון.
- לקרוא את הכסף של המועדון: תשלומים או הכנסות. הפרסים, הפרייז פול וכספי הפרס של כל שחקן מופיעים רק כפי שהשחקנים רואים אותם, כשהמועדון מציג אותם.
- לדפדף ברשימת הטורנירים או לסנן אותה. יש בה עד 200, בלי עמוד הבא.
- לקבל רשימה של טורנירים שהסתיימו או שעברו. במקום זה קראו טורניר שהסתיים לפי ה-ID שלו.
- לראות טורנירים שמוסתרים מהשחקנים, או את טורניר התרגול.
- לקבל קריאות מעמוד בדפדפן. קריאה שנושאת כותרת
Originשל דפדפן מהאתר שלכם נדחית. - לפעול בשם מועדון אחר. מפתח קורא ושולח הרשמות רק עבור המועדון שלו, וכל טורניר אחר עונה
404. - ליצור, להציג או לבטל מפתחות. רק הבעלים עושה את זה, באפליקציית הווב.
- להודיע לשרת שלכם כשמשהו משתנה. אין webhooks: קראו את הרשימה שוב כשאתם צריכים.
מגבלות ושגיאות
כל מפתח יכול לבצע 10 קריאות בשנייה ו-300 קריאות ב-10 דקות, לכל שלוש הקריאות יחד, ולשלוח 200 הרשמות חדשות בכל 24 שעות. הרשמה שנשלחת שוב אחרי שהצוות דחה אותה נספרת כחדשה. שליחה חוזרת של הרשמה שעדיין מחכה לא נספרת ב-200. בנוסף, קריאות מכתובת IP אחת מוגבלות לכל אחת משלוש הקריאות: 30 בשנייה, 150 ב-10 שניות ו-600 בדקה, לא משנה באילו מפתחות הן משתמשות.
| סטטוס | errorCode | מה זה אומר | מה לעשות |
|---|---|---|---|
| 400 | אין | הגוף שגוי: הוא לא JSON תקין, שדה חסר, ריק, ארוך מדי או לא מותר, האימייל לא תקין, נשלחו שתי הדרכים, הגיע שם בלי טלפון ובלי אימייל, או שהטלפון לא תקין או שהוא מספר ממלא מקום. | תקנו את הבקשה. ההודעה אומרת מה שגוי. |
| 401 | אין | המפתח חסר, לא נשלח עם ClubKey ורווח לפניו, שגוי או מבוטל. | בדקו את המפתח. אם הוא בוטל, בקשו מהבעלים של המועדון מפתח חדש. |
| 403 | CLUB_API_NEEDS_PLAN | למועדון אין תוכנית: הוא בתקופת הניסיון החינמית, התוכנית שלו הסתיימה, או שהמנוי שלו לא שולם. | בקשו מהמועדון לבחור תוכנית. המפתח עובד שוב ברגע שהוא בוחר. |
| 403 | אין | למפתח אין את ההרשאה שהקריאה הזו צריכה. | בקשו מהבעלים מפתח עם ההרשאה הזו. |
| 403 | CLUB_API_BROWSER_BLOCKED | הקריאה נשאה כותרת Origin של דפדפן מהאתר שלכם. קריאות מגיעות רק מהשרת שלכם. | קראו מהשרת שלכם, בלי כותרת Origin. |
| 403 | APP_REG_DISABLED | ההרשמה כבויה בטורניר הזה, או שהשחקן הזה לא יכול להירשם במועדון הזה. | אל תנסו שוב. אמרו לשחקן לפנות למועדון. |
| 404 | אין | הטורניר הוא לא טורניר שהמפתח שלכם יכול לראות (של מועדון אחר, מוסתר מהשחקנים, טורניר התרגול, או מזהה שלא קיים), או שהשחקן לא ברשימת השחקנים של המועדון. | בדקו את המזהה, וקראו שוב את רשימת הטורנירים. |
| 409 | APP_REG_CLOSED | ההרשמה לטורניר הזה סגורה: ההרשמה המאוחרת נגמרה, הצוות סגר את ההרשמה, השלב האחרון נגמר והצוות סוגר את התוצאות, או שהטורניר הסתיים. | אל תנסו שוב. הפסיקו להציע הרשמה לטורניר הזה. |
| 409 | APP_REG_CAP_FULL | הטורניר הגיע למגבלת ההרשמות שלו, שנמצאת ב-details.limit. | אל תנסו שוב, אלא אם מתפנה מקום. |
| 409 | APP_REG_ALREADY_ENTERED | השחקן כבר משחק בטורניר הזה. | כלום: השחקן בפנים. |
| 409 | TOURNAMENT_BUSY | מישהו שמר את הטורניר הזה באותו רגע. שום דבר לא השתנה. | נסו שוב בעוד רגע. |
| 413 | PAYLOAD_TOO_LARGE | הגוף גדול מ-100 kB. | שלחו רק את השדות שבעמוד הזה. |
| 429 | CLUB_KEY_DAILY_SIGNUP_LIMIT | המפתח שלח 200 הרשמות חדשות ב-24 השעות האחרונות, המגבלה שנמצאת ב-details.limit. | חכו את מספר השניות שבכותרת Retry-After, שמופיע גם ב-details.retryAfterSeconds: עד אז הרשמה תצא מחלון 24 השעות. |
| 429 | אין | יותר מדי קריאות: מעל 10 בשנייה או 300 ב-10 דקות למפתח הזה, או מעל המגבלות של כתובת ה-IP שלכם. אחרי 300 קריאות, המפתח נדחה לעד 10 דקות. | חכו את מספר השניות שבכותרת Retry-After, ואז קראו בתדירות נמוכה יותר. המגבלות של כתובת ה-IP שולחות במקומה Retry-After-short, Retry-After-medium או Retry-After-long. |
| 500 | INTERNAL_ERROR | משהו נכשל אצלנו. | נסו שוב אחרי המתנה קצרה. שליחה חוזרת של הרשמה בטוחה. |
| 503 | DB_STATEMENT_TIMEOUT | מסד הנתונים שלנו לקח יותר מדי זמן לענות. שום דבר לא השתנה. | נסו שוב אחרי המתנה קצרה. |
שינויים
זו גרסה 1, שנקראת v1 בכל נתיב. אנחנו רק מוסיפים לה: שדות חדשים בתשובות, אף פעם לא שדה שהוסר או ששמו שונה. התעלמו משדות שאתם לא מכירים, כך ששדה חדש אף פעם לא ישבור לכם את הקוד.
שאלות על ה-API? צרו איתנו קשר.