User Access Token
Last updated
Last updated
The Whisk Graph API uses OAuth 2.0 to allow developers to get a user access token to access a single user’s data or do actions on their behalf. OAuth 2.0 is a specification outlined in RFC 6749 that allows third-party services to make requests on behalf of a user without accessing passwords and other sensitive information. If you are unfamiliar with OAuth 2.0, check out Aaron Parecki’s "OAuth 2 Simplified" guide.
OAuth 2.0 Endpoints
First, the user has to grant your app permission to access their data or do actions on their behalf. Whisk provides an authorization page where users can securely sign in with their Whisk username and password or accounts from other providers (Google, Facebook, etc.) to grant permissions. This authorization page is accessed through the authorization URL. To ensure that the driver grants permissions to your app properly, supply query parameters to that URL as described below.
After you’ve supplied the needed parameters, present this authorization URL as a link for the user to visit.
Once the Whisk user authenticates and authorizes your app, Whisk will issue an HTTP 302 redirect to the redirect_uri passed in Step 1. On that redirect, you will receive a single-use authorization code that expires in 1 day.
This is the authorization code you need for the next step.
In order for the redirect to work correctly, Whisk will need to approve the url. You will need to contact support in the dashboard.
Use the Token Exchange endpoint to exchange the authorization code for an access_token which will allow you to make requests on behalf of the user.
Example Request:
Example Response:
The access_token is valid for the time described by expires_in (in seconds). The refresh_token expires after one year and can be used to obtain a new access_token at any time given that your application is still authorized to access the API on behalf of this user.
The scope in the token response indicates what access was actually granted by user.
The access_token retrieved from authenticating a user account will stay active even when a user changes the account password or other account details.
If you requested the access token with the offline_accessscope the response will include a refresh_tokenwhich can be used to refresh the access token. When the user’s access_tokenhas expired, you can obtain a new access_tokenby exchanging the refresh_tokenassociated with the access_tokenusing the Token Exchange endpoint.
Refreshing the user access token means that you don’t need to ask the user to authorize your app for the same permissions again (offline_access).
A refresh_tokenis valid for one year and tokens that have been inactive for more than one year will be invalidated.
Implicit flow is the less secure approach. Please consider Code Grant flow instead.
First, the user has to grant your app permission to access their data or do actions on their behalf. Whisk provides an authorization page where users can securely sign in with their Whisk username and password or accounts from other providers (Google, Facebook, etc.) to grant permissions. This authorization page is accessed through the authorization URL. To ensure that the driver grants permissions to your app properly, supply query parameters to that URL as described below.
After you’ve supplied the needed parameters, present this authorization URL as a link for the user to visit.
Unlike the authorization code grant type, in which the client makes separate requests for authorization and for an access token, the client receives the access token as the result of the authorization request.
Once the Whisk user authenticates and authorizes your app, Whisk will issues an access token and delivers it by adding the following parameters to the fragment component of the redirection URI using the application/x-www-form-urlencoded format
Example Response:
The access_tokenis valid for the time described by expires_in(in seconds). The refresh_tokendoes not return.
The access_tokenretrieved from authenticating a user account will stay active even when a user changes the account password or other account details.
You can pass the access_token returned in the previous steps as a bearer token in the Authorization header, or pass it in as a query parameter in the URL.
Example: OAuth token sent in a header
Authorization Host
https://login.whisk.com
Authorization Endpoint
https://login.whisk.com/oauth/v2/authorize
Token Exchange Endpoint
https://login.whisk.com/oauth/v2/token
PARAMETER
DESCRIPTION
response_type
OAuth 2.0 response type. code
client_id
The client ID of your application.
scope
The scope defines which part of user data will be accessed by your app. Your application can request multiple scopes as a space or comma-separated list.
redirect_uri
The URI we will redirect back to after authorization by the resource owner.
state (optional)
State which will be passed back to you to prevent tampering.
identity_provider (optional)
If provided, the authorization process is immediately forwarded to the specified identity provider (e.g. Google, Facebook)
PARAMETER
DESCRIPTION
client_id
The Client ID of your application.
client_secret
The Client Secret of your application.
grant_type
In this step, this should be set to authorization_code
redirect_uri
The base of the URI must match the redirect_uri used during Step 1 above.
code
The authorization code from Step 2: Receive Redirect.
PARAMETER
DESCRIPTION
response_type
OAuth 2.0 response type. token
client_id
The client ID of your application.
redirect_uri
The URI we will redirect back to after authorization by the resource owner.
state (optional)
State which will be passed back to you to prevent tampering.
identity_provider (optional)
If provided, the authorization process is immediately forwarded to the specified identity provider (e.g. Google, Facebook)