Qodex.ai

API 1.0

Number of APIs: 320

Welcome to TeamSportz sports platform API

You can find here general technical information about the TeamSportz API to enables you programmatically integrate your app or application with the TeamSportz sports platform.

What is an API (Application Programming Interface)?

APIs act as a bridge between a server and the application interface. When you request specific information from a mobile or web application, a message is transmitted to the server. The API facilitates server-to-application communication by defining a set of principles and a structured data format. The type of API used by TeamSportz is the RESTfull API.

What is the REST (Representational State Transfer) API?

This type of API is accessed via an HTTP (Hypertext Transfer Protocol) request by executing various actions on a URL (Uniform Resource Locator) containing resources such as GET, POST, DELETE, and PUSH.

The API enables your to fully manage your Club, Teams, Coaches and Players as well as a variety of services and features of the platform. Note that the API has been designed to covers a variety of use cases such as sports clubs and sports organisations, Gyms and or fitness trainers. If your particular case study is not covered here please contact hello@teamportz.pro

With exception of the registration, all requests to the TeamSportz API require authentication. It's fundamental to understand that TeamSportz API has two sides:**

  • Players (users)

  • Club Management (admin)

By starting with the Registration endpoints you will be on your way to start consume TeamSportz platform services. However, to use the Club Management endpoints you need a 3rd Party API Secrete Key. Request your 3rd Party API Key at dev@teamsportz.pro

This documentation will guide you through the each endpoint and what a response will look like. All endpoints have been grouped by their respective domain. For example Players or Videos, etc.

Depending on the role or authorization scope, endpoints might have different responses. TeamSportz API assumes the following Roles:

  • Individual Player (user - not associated to a Team)

  • Team Player (user - associated to a Team)

  • Coach (manager)

  • Head Coach (admin - attached to billing)

If you have any technical questions please write to dev@teamsportz.pro if you have business or partnership questions please write to hello@teamsportz.pro.

  1. Registration - Coaches sign up POST {{baseUrl}}/v1/clubs/signup

  2. Login - Update password POST {{baseUrl}}/{{version}}/auth/update

  3. Login - Login POST {{baseUrl}}/v1/auth/login

  4. Login - Confirm email GET {{baseUrl}}/{{version}}/auth/confirm/email/?email_confirmation_token={{confirmEmailToken}}

  5. Login - Logout POST {{baseUrl}}/v1/auth/logout

  6. Login - Reset my password POST {{baseUrl}}/{{version}}/auth/reset

  7. Login - Change email POST {{baseUrl}}/{{version}}/accounts/change/email

  8. Login - Refresh auth token GET {{baseUrl}}/{{version}}/auth/refresh

  9. Login - Resend signup email POST {{baseUrl}}/{{version}}/coaches/signup/resend/{{email}}

  10. Onboarding - Onboard a Player POST {{baseUrl}}/{{version}}/onboarding/player/{{user_id}}