Strava API REST client with OAuth authentication
PHP
Latest commit 0d82855 Sep 19, 2016 Bas van Dorst 1.0.2

README.md

StravaPHP

Build Status Code Coverage Scrutinizer Code Quality

TLDR; Strava V3 API PHP client with OAuth authentication

The Strava V3 API is a publicly available interface allowing developers access to the rich Strava dataset. The interface is stable and currently used by the Strava mobile applications. However, changes are occasionally made to improve performance and enhance features. See the changelog for more details.

In this GitHub repository you can find the PHP implementation of the Strava V3 API. The current version of StravaPHP combines the V3 API with a proper OAuth authentication.

Getting started

Get your API key

All calls to the Strava API require an access token defining the athlete and application making the call. Any registered Strava user can obtain an access token by first creating an application at strava.com/developers

Composer package

Use composer to install this StravaPHP package.

{
    "require": {
        "basvandorst/StravaPHP": "1.0.2"
    }
}

StravaPHP usage

First, authorisation and authentication

<?php
include 'vendor/autoload.php';

use Strava\API\OAuth;
use Strava\API\Exception;

try {
    $options = array(
        'clientId'     => 1234,
        'clientSecret' => 'APP-TOKEN',
        'redirectUri'  => 'http://my-app/callback.php'
    );
    $oauth = new OAuth($options);

    if (!isset($_GET['code'])) {
        print '<a href="'.$oauth->getAuthorizationUrl().'">connect</a>';
    } else {
        $token = $oauth->getAccessToken('authorization_code', array(
            'code' => $_GET['code']
        ));
        print $token;
    }
} catch(Exception $e) {
    print $e->getMessage();
}

Then, call your API method!

<?php
include 'vendor/autoload.php';

use Pest;
use Strava\API\Client;
use Strava\API\Exception;
use Strava\API\Service\REST;

try {
    $adapter = new Pest('https://www.strava.com/api/v3');
    $service = new REST($token, $adapter);  // Define your user token here..
    $client = new Client($service);

    $athlete = $client->getAthlete();
    print_r($athlete);

    $activities = $client->getAthleteActivities();
    print_r($activities);

    $club = $client->getClub(9729);
    print_r($club);
} catch(Exception $e) {
    print $e->getMessage();
}

Class documentation

Strava\API\Factory

Usage

// Configure your app ID, app token and callback uri
$factory = new Factory();
$OAuthClient = $factory->getOAuthClient(1234, 'APP-TOKEN', 'http://my-app/callback.php');

Methods

$factory->getOAuthClient($client_id, $client_secret, $redirect_uri);
$factory->getAPIClient($token);

Strava\API\OAuth

Usage

// Parameter information: http://strava.github.io/api/v3/oauth/#get-authorize
$options = array(
    'clientId'     => 1234,
    'clientSecret' => 'APP-TOKEN',
    'redirectUri'  => 'http://my-app/callback.php'
);
$oauth = new OAuth($options);

// The OAuth authorization procces (1st; let the user approve, 2nd; token exchange with Strava)
if (!isset($_GET['code'])) {
    print '<a href="'.$oauth->getAuthorizationUrl().'">connect</a>';
} else {
    $token = $oauth->getAccessToken('authorization_code', array('code' => $_GET['code']));
    print $token;
}

Methods

$oauth->getAuthorizationUrl($options = array());
$oauth->getAccessToken($grant = 'authorization_code', $params = array());

Strava\API\Client

Usage

// REST adapter (We use `Pest` in this project)
$adapter = new Pest('https://www.strava.com/api/v3');
// Service to use (Service\Stub is also available for test purposes)
$service = new Service\REST('RECEIVED-TOKEN', $adapter);

// Receive the athlete!
$client = new Client($service);
$athlete = $client->getAthlete();
print_r($athlete);

Methods

$client->getAthlete($id = null);
$client->getAthleteStats($id);
$client->getAthleteClubs();
$client->getAthleteActivities($before = null, $after = null, $page = null, $per_page = null);
$client->getAthleteFriends($id = null, $page = null, $per_page = null);
$client->getAthleteFollowers($id = null, $page = null, $per_page = null);
$client->getAthleteBothFollowing($id, $page = null, $per_page = null);
$client->getAthleteKom($id, $page = null, $per_page = null);
$client->getAthleteStarredSegments($id = null, $page = null, $per_page = null);
$client->updateAthlete($city, $state, $country, $sex, $weight);
$client->getActivity($id, $include_all_efforts = null);
$client->getActivityComments($id, $markdown = null, $page = null, $per_page = null);
$client->getActivityKudos($id, $page = null, $per_page = null);
$client->getActivityPhotos($id, $size = 2048, $photo_sources = 'true');
$client->getActivityZones($id);
$client->getActivityLaps($id);
$client->getActivityUploadStatus($id);
$client->createActivity($name, $type, $start_date_local, $elapsed_time, $description = null, $distance = null);
$client->uploadActivity($file, $activity_type = null, $name = null, $description = null, $private = null, $trainer = null, $data_type = null, $external_id = null);
$client->updateActivity($id, $name = null, $type = null, $private = false, $commute = false, $trainer = false, $gear_id = null, $description = null);
$client->deleteActivity($id);
$client->getGear($id);
$client->getClub($id);
$client->getClubMembers($id, $page = null, $per_page  = null);
$client->getClubActivities($id, $page = null, $per_page  = null);
$client->getSegment($id);
$client->getSegmentLeaderboard($id, $gender = null, $age_group = null, $weight_class = null, $following = null, $club_id = null, $date_range = null, $page = null, $per_page = null);
$client->getSegmentExplorer($bounds, $activity_type = 'riding', $min_cat = null, $max_cat = null);
$client->getSegmentEffort($id, $athlete_id = null, $start_date_local = null, $end_date_local = null, $page = null, $per_page = null);
$client->getStreamsActivity($id, $types, $resolution = null, $series_type = 'distance');
$client->getStreamsEffort($id, $types, $resolution = null, $series_type = 'distance');
$client->getStreamsSegment($id, $types, $resolution = null, $series_type = 'distance');

UML diagrams

Class diagram

class

Sequence diagram

sequence

About StravaPHP

Used libraries

Development

The StravaPHP library was created by Bas van Dorst, software engineer and cyclist enthusiast.

Contributing

All issues and pull requests should be filled on the basvandorst/StravaPHP repository.

License

The StravaPHP library is open-source software licensed under MIT license.