Clone this wiki locally
AKA ‘OAuth made so easy your grandma can do it’)Getting Started With Scribe (
In this tutorial we will walk through an example on how to use Scribe with Twitter.
For an executable example please go here
Step Zero: Install Scribe
First of all, you need to install scribe. You either download the jar manually from the downloads page and include apache commons codec, or just let maven take care of everything adding this to your pom.xml file:
<dependency> <groupId>org.scribe</groupId> <artifactId>scribe</artifactId> <version>1.3.7</version> // please use always the latest version </dependency>
Step One: Create the OAuthService object
OAuthService service = new ServiceBuilder() .provider(TwitterApi.class) .apiKey("your_api_key") .apiSecret("your_api_secret") .build();
Yup, that’s it. :)
The example uses OOB OAuth, if you want to pass a callbackUrl so that Twitter redirects you there just add
callback("http://your_callback_url") call before
Step Two: Get the request token
Token requestToken = service.getRequestToken();
Step Three: Making the user validate your request token
Let’s help your users authorize your app to do the OAuth calls.
For this you need to redirect them to the following URL:
String authUrl = service.getAuthorizationUrl(requestToken);
After this either the user will get a verifier code (if this is an OOB request) or you’ll receive a redirect from Twitter with the verifier and the requestToken on it (if you provided a callbackUrl)
Step Four: Get the access Token
Now that you have (somehow) the verifier, you need to exchange your requestToken and verifier for an accessToken which is the one used to sign requests.
Verifier v = new Verifier("verifier you got from the user"); Token accessToken = service.getAccessToken(requestToken, v); // the requestToken you had from step 2
Step Five: Sign request
You are all set to make your first API call, so let’s do it!
OAuthRequest request = new OAuthRequest(Verb.GET, "http://api.twitter.com/1/account/verify_credentials.xml"); service.signRequest(accessToken, request); // the access token from step 4 Response response = request.send(); System.out.println(response.getBody());
That’s it! You already know everything you need to start building a cool OAuth application.
Doubts – Comments
email me at:
or ping me via Twitter at: