Introduction
Clippd is an AI-focussed technology business building a connected future for golfers and coaches who have a passion for performance. At our core is a universal platform that aggregates all the performance data created by millions of golfers and coaches every day. You can visit https://clippd.com to learn about our flagship performance platform.
Scoreboard powered by Clippd, provides tournament scoring, real-time leaderboards, detailed statistics, in-depth analytics and media through a platform that includes easy-to-navigate screens allowing users to keep track of their favorite teams and players. You can view the latest scores, results and rankings published at https://scoreboard.clippd.com and coaches can manage their schedules, tournaments and ranking submissions through the Admin portal at https://admin.scoreboard.clippd.com
Scoreboard Partner API
This documentation provides the Scoreboard Powered by Clippd Partner API, for integration partners to provide LIVE scoring for tournaments and securely submit end of round scores for both predicted and final ranking submissions. The Partner API is designed with a trusted API Key authentication mechanism and Clippd team will be happy to provision non exclusive keys for both sandbox (a.k.a Development) as well as production environments for every partner in an Open and collaborative fashion.
The "production" version of the partner portal is provided at https://partner.scoreboard.clippd.com and the documentation will be available at https://partner.scoreboard.clippd.com/docs
Code
Live Scoring Integration
NCAA and the other governing bodies require golf coaches to create and manage tournaments in the Scoreboard Admin portal https://admin.scoreboard.clippd.com. However a partner could require an initial setup for LIVE scoring to be orchestrated through their portal. We provide an initiation handshake between our platform and the partner portal on a event-by-event basis. The coach would typically setup a tournament in the Admin portal and would select "Live Score" to be provided by the chosen partner. This would generate a secret code which then can be used to make that handshake for connecting the LIVE scoring event with the master tournament for ranking purposes.
The typical setup of a tournament takes a few steps, all of which could be performed purely on the Admin portal and/or completely on the partner portal. We allow both read and write of all of the setup information; actions that are mandatory are marked with a [+] while others are purely informational for better display of results after the tournament has concluded.
All of the below actions require the addtional secret key for the tournament
as an additional header marked by x-Tournament-Key field.
The list of the all the actions are below.
- Initiate Tournament [+] - Return the basic information for the tournament
- Update Tournament - [+] - Edit the basic details for a tournament including dates, course played etc
- Get Teams Lineup - Return the current lineup of teams that are set to participate in the tournament
- Update Teams Lineup [+] - Update the list of teams that are participating in the tournament
- Get Players Lineup - Return the current lineup of players at a team level that are set to participate in the tournament
- Update Players Lineup [+] - Update the player lineup for participants in the tournament
- Update Course Setup - Setup the pars and yardages for each round of the tournament
- Update Player Tee-time - Setup the tee groups and tee times for a given round
- Get Current Scores - Return the list of scores at a player / round level for the tournament
- Publish Stroke Play Scores [+] - Publish a set of updates or deletions or new data for stroke play rounds
- Publish Match Play Scores [+] - Publish a set of updates or deletions or new data for match play rounds
Informational APIs
We also provide an additional set of informational APIs for better managing the tournament and other exceptional use-cases like adding a new player who has been brought in substitution or temporarily. And APIs for course and venue search across the Clippd course database.
- Search Teams - Provide a simple search for teams in the Clippd database
- Get Player Roster - Return the list of players for a given team
- Add new Player [++]- Ability to add a new player to a team roster
- Search Venue - A simple search into the golf venues that are stored in the Clippd platform
- Search Course - A simple search into the golf courses and tees to return basic pars and yardages
NOTE: Adding new players may be removed in the future based on commercial considerations.
Data Models
For easy and quick reference, the following are the main models provided by Scoreboard Partner API
| Model | Description |
|---|---|
| School Team | represents a men / women team belonging to a school |
| Player | represents a player in the team's roster |
| Tournament | represents a basic details of the tournament |
| Stroke Play Scores | represents a scores object for an entire round of all players |