External System Integration Requirements

In the case that we are integrating into your system, we have specific requirements that your system needs to fulfill for efficiency and maintainability on our side.

Unique Ids

Most importantly is that your system has unique ids for every entity so our system can keep track of which matches, clubs, venues, match events, etc. are the same and map them toward our entities.

Real-time events vs Pull data

For our system to be as efficient as possible, and manage changes in real-time, we require a way to keep track of which entities have been updated, so we do not have to compare the result with the information we have stored. There are a few ways to achieve this:

• Real-time events

  • Use a messaging system or webhooks to notify our platform of updated, deleted or created events.

• Queries

  • Updated timestamp

    • A timestamp that describes when the most recent update to the respective entity was.

    • Be able to query on timestamps

      • “Changed since”

  • Filters & paging

    • Filter by a “last-pull-date” query, where all changes since that date are returned.

    • Paging data if large volumes

Queries

We need certain queries so that we can create and update entities in our system. The ones we are most interested in are the following.

• Matches (At least one of the following)

  • For a competition

  • For a venue

  • Upcoming with paging

  • Updated since <timestamp>

• Competitions (Optional)

  • For a season

• Clubs

  • Logos, names, home venue (optional)

• Match-events

  • Start/stop events

    • Used to start stop the cameras

  • Period/Intermission - start/stop

    • Used to display graphical overlas

  • Lineups - players, coaches, referees

  • Goals

    • Scorer, current standing

  • Penalties

Testing Environment

A controlled testing environment where edge cases and the like can be tested is greatly appreciated. Granting us access to creating matches, match-events, etc. means we can be efficient as possible.

Documentation

Some form of structured API documentation, whether swagger-docs or something else, is a must so that we know the technical requirements for using your APIs.