Sportlyzer's API

Welcome! The Sportlyzer API enables third-party developers to build applications on Sportlyzer’s automated training planning platform. You're free to build for the Web, the desktop, or on mobile devices.

Status

The API is currently under development.

API Terms & Guidelines

Sportlyzer is a training planning engine and a community for endurance sports enthusiasts. Before you start using our API, we have a few guidelines that we'd like you to follow.

You may use the Sportlyzer brand and logo, but not in ways that make users think that we built or endorse your app.

Commercial apps: If you're building an application that derives revenue from its use of the Sportlyzer API, please contact us. We reserve the right to ensure it doesn't harm our business interests.

Do:

Use the API responsibly. Please cache data when possible and handle errors appropriately.

Make it easy to include the message field with workouts shared to Sportlyzer and encourage social interaction.

Make a great user experience that integrates Sportlyzer in a valuable and expected way.

Don't:

Don't use Sportlyzer anywhere in the name of your application, URL or branding.

Don't replicate the core user experience of sportlyzer.com.

Don't store user’s username and password or any other user data without their express consent (using the API or crawling).

Don't abuse the API with too many requests. If you're unsure, ask us.

Applications that don't follow the guidelines above may be in violation of our Terms of Service and may have their API access revoked. We reserve the right to modify these terms and guidelines from time to time without notice.

API Getting started

To start using Sportlyzer API you need to request the access first! To get one send us an email to support[_at_]sportlyzer.com and write "API request" to the subject line. In your message please provide a link to your service and describe briefly what does it do. Also add your vision how our cooperation would be beneficial to you and us! We’ll give you a fast reply!

And add some lorem ipsum with some random numbers in the end, so we know you’re a hacker ;)

Authentication

We use one-time username+password based authentication.

Example

Let's say that we have Alice as our partner and Bob as our end-user.

  1. Alice enters her login information (email and password) into Bob's application.
  2. Bob's application sends that information to our /auth endpoint which replies with information containing agreement hash to be used for later requests.
  3. Bob's application stores the agreement hash (does not store the username or password) and uses it to do API requests on behalf of Alice.

Request

GET /auth?partner=&secret=&email=&password=

OK Resonse:

{ 'status': 'success', 'user':'20', 'agreement':'string max 80' }

If user not found:

{"status":"error","error":"email not found"}

The API

To use these methods below you need to be authenticated.

Include following with each request:

  1. partner - your partner key
  2. user - end-user id of sportlyzer
  3. agreement - your agreement with the end user

GET /club

Params:

\API_Client_Agreement agreement

\Club club

$crm_address 0

GET /coach

Params:

Club club

GET /docs

Params:

Club club

GET /latestversion

GET /support/club/[id]/[action] -> club_[action]

Params:

\API_Client_Agreement agreement

null club_id

null action

GET /test

Displays the current documentation.

Extending the API

If you want to get more out of Sportlyzer API please send us an email to support[-at-]sportlyzer.com and write "API feature request" to the subject line. In your message please describe briefly your needs. Also add your vision of your favored solution!

And add some lorem ipsum with some random numbers in the end, so we know you’re a hacker ;)

End of the API documentation