Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
20 lines (13 sloc) 2.32 KB

OAuth details

We use the Doorkeeper gem for OAuth, so you can refer to their docs on specifics of the end-points.

The API is divided up into access scopes:

  • read: Read data
  • write: Post statuses and upload media for statuses
  • follow: Follow, unfollow, block, unblock

Multiple scopes can be requested during the authorization phase with the scope query param (space-separate the scopes). If you do not specify a scope in your authorization request, the resulting access token will default to read access.

One possible way this might work for you:

  1. Get client_key and client_secret from your local cache. If you don't have the two, you need to register the application. Store client_key and client_secret in your local cache for next time. We actually don't need the id returned from this call.
  2. Get the refresh_token from your local cache. If you have one, any access token you might have has probably expired anyway. Refresh by visiting /oauth/token using a POST request with the parameters client_id=<client_key> (yes, this is confusing!), client_secret=<client_secret>, grant_type=refresh_token, refresh_token=<refresh_token>. Save the access_token you get back in your local cache.
  3. Get the access_token from your local cache. Try to connect. One simple way to do this is to verify credentials. Whatever API call you make, add the HTTP header Authorization: Bearer <access_token>.
  4. If you have neither refresh nor access token, tell the user to visit /oauth/authorize with parameters scope=read write follow (URL encode the space to %20, of course), response_type=code, redirect_uri=urn:ietf:wg:oauth:2.0:oob (assuming you don't want to redirect your users elsewhere), client_id=<client_key> (yes, this is confusing). The user clicks on the URL and gets shown a page asking them to authorize your app for reading, writing, and following (assuming this is the scope you requested, feel free to request less). If the user clicks on the right button, they get back a code. Store this code as your refresh_token. Go back to step #2.
You can’t perform that action at this time.