Overview

Access Types

For all API calls, your application needs to be authenticated, whether you want to access public or private data. When accessing private data your application will also require the adequate credentials of the tournament's owner to access the data.

Depending on the type of action you want to perform on the API, you must use either a simple or authorized access. Some API endpoints may also provide different responses depending on whether the call uses a simple or an authorized access. For example, some resources may have additional information when they are called using an authorized access.

  • Simple Access
    Allows to read public data.
  • Authorized Access
    Allows to read private data and write public or private data.

1. Simple access

This access allows your application to read public data without requiring a particular authorization. You cannot however write or update any information.

To use the simple access, you must authenticate your application with an API key. This key can be found on your application profile. You may learn more in the API key section.

2. Authorized access

The authorized access provides all the features and data from the simple access, but also allows your application to access private data on behalf of a user, like creating, editing or deleting a tournament and participants. More actions will be added, such as "tournament structure" and "participants placement".

API endpoints that require an authorized access will be marked as Authorized Access

Additional information provided by an authorized access will be marked as Private

To use the authorized access, you must authenticate your application with both an API key and OAuth 2 credentials. You may learn more in the API key section and in the OAuth 2 section.