The (Unofficial) Concept 2 Online Logbook REST API

1. Quick Start
2. Frequently Asked Questions
3. API Key
4. Calling the API
5. Response formats
6. API Methods
7. Roadmap

Quick Start

1. Get an api key from http://c2logapi.appspot.com/account/register.
2. Open http://c2logapi.appspot.com/api/1/user/totalmeters?format=xml&api_key=xxx replacing xxx with your API key. Enter your Concept 2 Online Logbook user id and password when prompted.

Key

Calling the API

Programmatically

The documentation for most api methods contains examples of calling them programmatically. Use basic authentication to provide the Concept 2 Online Logbook user name and password. The API will accept the normal basic-authentication string as a URL parameter ?authentication=YX......vdw== as an alternative to the standard authentication HTTP header.

Provide your API key in either a header called X-API-KEY or as a URL parameter '?api_key=xxxxxxxxxxxx'.

From a Browser

Append your API key to the URL using ?api_key=xxxxxxxxx.For example: http://c2logapi.appspot.com/api/1/currentseason/dates?api_key=xxxxxxxxx Use your Concept 2 Online Logbook user-name and password when prompted to login.

Response Formats

The default, preferred, and fully tested format is JSON.

Alternative formats are available on some methods. These are not tested as thoroughly as JSON. Specify them by appending ?format=X to the URL. X can be one of: xml, json, or pickle. Pickle returns pickled python objects representing the response data. Important note: some functions return only JSON data independent of this format.

For example: http://localhost:8000/api/1/currentseason/dates?&api_key=xxxxxxxxxxxxx may return:

{
   "start": "2009-05-01 00:00:00",
   "end": "2010-04-30 00:00:00"
}

<response>
   <start>2009-05-01 00:00:00</start>
   <end>2010-04-30 00:00:00</end>
</response>

Methods

1. User's Total Meters
   
2. User's Team
   
3. Current-Season Dates
   
4. Current-Season Workouts - Get All Workouts
   
5. Current-Season Workouts - Add New Workout
   
6. Current-Season Workouts - Delete All
   
7. Current-Season Workout - Get One
   
8. Current-Season Workout - Delete
   
9. Historical Monthly Summaries - Get All Summaries
   

Roadmap

Implemented

• User's Total Meters
• User's Team
• Current-Season Dates
• Current-Season Workouts - Get All Workouts
• Current-Season Workouts - Add New Workout
• Current-Season Workouts - Delete All
• Current-Season Workout - Get One
• Current-Season Workout - Delete
• Historical Monthly Summaries - Get All Summaries

Coming

• Historical Monthly Summaries - Add a Summmary
• Historical Monthly Summaries - Delete All
• Historical Monthly Summary - Get One
• Historical Monthly Summary - Delete One
• Current-Season Workouts - RANK a workout
• Current-Season Workouts - Show current RANKed workouts