javastrava.api.v3.rest

Interface AuthorisationAPI

public interface AuthorisationAPI

API implementation of the Strava REST interface for authorisation

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
TokenResponse	tokenExchange(Integer clientId, String clientSecret, String code)

Method Detail

tokenExchange

@FormUrlEncoded
 @POST(value="/oauth/token")
TokenResponse tokenExchange(@Field(value="client_id")
                                                                           Integer clientId,
                                                                           @Field(value="client_secret")
                                                                           String clientSecret,
                                                                           @Field(value="code")
                                                                           String code)
                                                                    throws BadRequestException,
                                                                           UnauthorizedException

Parameters:

clientId - application's ID, obtained during registration

clientSecret - application's secret, obtained during registration

code - authorisation code

Returns:

Returns an access_token and a detailed representation of the current athlete.

Throws:

BadRequestException - Where the request does not contain all the required information

UnauthorizedException - If client secret is invalid

See Also:

AuthorisationService.tokenExchange(java.lang.Integer, java.lang.String, java.lang.String, AuthorisationScope...)