Introduction

Cortex provides a dedicated capability for creating player profiles for your website or app. These can be created and edited in Cortex, and pulled in via API. It is a headless content service, meaning that styling of the player, team or squad page is the responsibility of the front end developer.

Players - API call constructs

Below are the API calls that may be used to fetch a player or team.

To fetch all players:

💻

GET {environment-ID}/v1/clients/{client-ID}/players

In which:

{environment-ID} is the URL for stage (test) or production (live).

• Stage: https://players-stage.cortextech.io
• Production: https://players.cortextech.io
• Production (US environment): https://players.cortextech.us

{client-ID} is your client ID, assigned during onboarding.

For example:

💻

GET https://players.cortextech.io/v1/clients/DEMO/players

To fetch a player by ID:

💻

GET {environment-ID}/v1/clients/{client-ID}/players/{player-ID}

In which:

{environment-ID} and {client-ID} are as described above.

{player-ID} is the identifier for an individual player. This ID can be obtained from the API described above, or from the Cortex platform.

For example:

💻

GET https://players.cortextech.io/v1/clients/DEMO/players/666ab91e5555da231647dc66

To fetch a player by slug

💻

GET {environment-ID}/v1/clients/{client-ID}/players/slug/{slug}

In which:

{environment-ID} and {client-ID} are as described above.

slug is the identifier for an individual player, set by the Cortex user. This can be set in, or obtained from, the Cortex platform, or obtained from the API described above.

A slug is unique within the client ID, and therefore can be used as a unique identifier for the player. Additionally, it will not contain spaces or special characters (other than those supported in URLs). This means it can be used to define the URL of the player profile page.

For example:

💻

GET https://players.cortextech.io/v1/clients/DEMO/players/slug/pele

To fetch all teams

💻

GET {environment-ID}/v1/clients/{client-ID}/teams

For example:

💻

GET https://players.cortextech.io/v1/clients/DEMO/teams

Localisation

To return players filtered by language

The endpoints explained above can be queried by language or locale, using the parameter ?language={language}, in which:

language is the code for the language or locale to be requested. This is set in Cortex for each player and team, and the code follows the BCP-47 standard (for example, it could include either or both of es for Spanish in general or es-AR for Spanish (Argentina))

Where using the ?language parameter, as described above, you can additionally specify a set of fallback languages to be used where there was no match for the primary language in the request. This can be achieved using the parameter &fallbackLanguages={language1},{language2},{language3}, in which:

{language1},{language2},{language3} is the list of fallback languages, comma separated, in the order in which they should be prioritised. Each language should be specified using a code from the BCP-47 standard.

For example:

💻

GET https://players.cortextech.io/v1/clients/DEMO/players?language=pt&\&fallbackLanguages=pt-BR,en

Default behaviour

The player will be loaded using the default locale, as set in the Cortex platform, if you do not specify a locale in the query; or if there is no available variant matching the specified locale or fallback locales.

For example, given the query ?language=pt&fallbackLanguages=es, if there is no Portuguese or Spanish variant of the player, then the default variant would be provided.

A note on localised teams and positions

In the JSON, part of the player object may include a position or team, if these attributes have been added to the player in Cortex. Each team and position has its own translations and default locale, and follow the same rules described above in relation to fallback languages and default behaviour.

For example, given the query ?language=pt&fallbackLanguages=es, if there is no Portuguese variant of the player, but there is a Portuguese variant of the team, then the Spanish variant of the player would be provided including variant of the Portuguese team.