API reference
The reference is generated from the live cloud API description (OpenAPI) and checked against the code. App and club panel sections that are not meant for integrations are not included.
1C integration 4
Club payments pushed from 1C (Russian accounting system) to player wallets. Access: the 1C token in the X-1C-Token header.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | Ping and token check | /v1/integrations/1c/ping | 1C token |
| POST | Import payments | /v1/integrations/1c/payments | 1C token |
| GET | List payments (reconciliation) | /v1/integrations/1c/payments | 1C token |
| POST | Re-match unmatched payments | /v1/integrations/1c/payments/retry | 1C token |
MATCHi integration 1
MATCHi court booking events: booking created, moved, cancelled. Access: the MATCHi signature in the x-matchi-signature header.
| Method | Title | Path | Access |
|---|---|---|---|
| POST | MATCHi court booking event | /v1/integrations/matchi/{club_id} | MATCHi signature |
Court server: data ingest 13
Match results, stats, movement, clips, live score, americano, tournament bracket, levels and player passes. Access: the club token in X-Club-Token.
| Method | Title | Path | Access |
|---|---|---|---|
| POST | Match result from the court | /v1/ingest/match-result | Club token |
| POST | Match stats | /v1/ingest/match-stats | Club token |
| POST | Player movement | /v1/ingest/match-movement | Club token |
| POST | Clip metadata | /v1/ingest/clips | Club token |
| PUT | Upload clip file | /v1/ingest/clips/file | Club token |
| POST | Player highlight during the match | /v1/ingest/player-clip | Club token |
| POST | Live court score | /v1/ingest/live | Club token |
| GET | Current americano game on a court | /v1/ingest/quick-games | Club token |
| POST | Americano game score from the court | /v1/ingest/quick-games/{game_id}/score | Club token |
| GET | Bracket match on a court | /v1/ingest/bracket | Club token |
| POST | Bracket match result from the court | /v1/ingest/bracket/{match_id}/result | Club token |
| GET | Player levels for the terminal | /v1/ingest/levels | Club token |
| POST | Check a player pass in the cloud | /v1/ingest/player-pass | Club token |
Court server: computer vision 6
Rallies with ball trajectory, match summary, camera health and court bookings. Writes use the club token; reads accept the club token or a player token.
| Method | Title | Path | Access |
|---|---|---|---|
| POST | Rally | /v1/cv/rally | Club token |
| POST | Match summary | /v1/cv/match-summary | Club token |
| POST | Court health | /v1/cv/health | Club token |
| GET | Match computer vision data | /v1/cv/match/{match_id} | Club token or player token |
| GET | Latest court health | /v1/cv/court/{court}/health | Club token or player token |
| GET | Court bookings now | /v1/cv/court-bookings | Club token |
Court server license 1
Signed license for a club court server machine. Access: the club token.
| Method | Title | Path | Access |
|---|---|---|---|
| POST | Issue a court server license | /v1/license/court | Club token |
Live score 1
Score of matches in progress on the club courts, for scoreboards, websites and apps. Public method.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | Live scores of club courts | /v1/live/{club_id} | Public |
Leads 1
Requests from a website, an ad or the club front desk. Public method.
| Method | Title | Path | Access |
|---|---|---|---|
| POST | Create a lead | /v1/leads | Public |
Clubs and slots 4
Clubs, courts and free slots for a day with prices. Public methods.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | List clubs | /v1/clubs | Public |
| GET | Club | /v1/clubs/{club_id} | Public |
| GET | Club courts | /v1/clubs/{club_id}/courts | Public |
| GET | Club slots for a day | /v1/clubs/{club_id}/slots | Public |
Bookings 16
Court booking on behalf of a player: create, reschedule, cancel, waitlist, split payment, rentals, promo codes. Access: a player token.
| Method | Title | Path | Access |
|---|---|---|---|
| POST | Create a booking | /v1/bookings | Player token |
| GET | My bookings | /v1/bookings/my | Player token |
| POST | Cancel a booking | /v1/bookings/{booking_id}/cancel | Player token |
| POST | Reschedule a booking | /v1/bookings/{booking_id}/reschedule | Player token |
| GET | My booking rules in a club | /v1/bookings/rules | Player token |
| GET | Check a promo code | /v1/promo/check | Player token |
| POST | Join the waitlist | /v1/bookings/waitlist | Player token |
| GET | My waitlist | /v1/bookings/waitlist/my | Player token |
| POST | Leave the waitlist | /v1/bookings/waitlist/{wait_id}/cancel | Player token |
| POST | Split the booking payment | /v1/bookings/{booking_id}/split | Player token |
| GET | My pending shares | /v1/bookings/splits/my | Player token |
| POST | Pay my share | /v1/bookings/splits/{split_id}/accept | Player token |
| GET | Rental items in a club | /v1/bookings/rental | Player token |
| POST | Add rental to my booking | /v1/bookings/{booking_id}/rental | Player token |
| GET | Rental on a booking | /v1/bookings/{booking_id}/rental | Player token |
| GET | Rental QR for a booking | /v1/bookings/{booking_id}/rental-pass | Player token |
Wallet and payments 4
Player balance, top-up through YooKassa and YooKassa notifications.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | Player wallet | /v1/wallet | Player token |
| POST | Top up the wallet | /v1/wallet/topup | Player token |
| GET | Top-up payment status | /v1/wallet/payments/{payment_id} | Player token |
| POST | YooKassa notification | /v1/wallet/yookassa/webhook | YooKassa only |
Matches 7
Player matches, match card with highlights, manual score entry and correction, rally marking. Access: a player token.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | My matches | /v1/matches/my | Player token |
| GET | Match card | /v1/matches/{match_id} | Player token |
| POST | Manual score entry | /v1/matches/manual | Player token |
| POST | Score correction by a referee | /v1/matches/{match_id}/score-correction | Club panel account |
| POST | Mark a rally for highlights | /v1/matches/mark | Player token |
| GET | Match text review | /v1/matches/{match_id}/review | Player token |
| POST | Share link for a clip | /v1/matches/{match_id}/clips/{clip_id}/share | Player token |
Players 2
Player profile and recent partners. Access: a player token.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | Recent players | /v1/players/recent | Player token |
| GET | Player profile | /v1/players/{player_id} | Player token |
AISOLUS rating 4
The 1.0–7.0 scale, player rating and top players.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | Rating scale | /v1/rating/scale | Public |
| GET | My rating | /v1/rating/me | Player token |
| GET | Another player's rating | /v1/rating/user/{uid} | Player token |
| GET | Top players by AISOLUS rating | /v1/rating/leaderboard | Player token |
Leaderboard 1
Leaderboard by Elo rating. Public method.
| Method | Title | Path | Access |
|---|---|---|---|
| GET | Elo leaderboard | /v1/leaderboard | Public |