Implementing Android Rest Client using the Magento REST api with Scribe Library

Thanks to Pablo Fernandez for creating Scribe library for us.

First we have to generate the REST roles and consumers in the Magento dashboard, the roles are going to map the resources inside Magento that this role need access to and the consumer is going to represent the keys to be used inside our custom app that use the Scribe framework.

In order to add consumers to Magento from the REST api we create an OAuth REST Consumer where it will store the keys to be used by our app. We create them using the Magento dashboard and selecting System > Web Services > REST – OAuth Consumers like in the next image.

Let us first add dependency in the project:

compile 'org.scribe:scribe:1.3.7'

1

compile 'org.scribe:scribe:1.3.7'

Android Rest API client will implemented as:

public class MainActivity extends AppCompatActivity {

    final String MAGENTO_API_KEY = "YOUR_MAGENTO_API_KEY";
    final String MAGENTO_API_SECRET = "YOUR_MAGENTO_API_SECRET";
    final String MAGENTO_REST_API_URL = "YOUR_MAGENTO_REST_API_URL";

    private static Token requestToken;
    private OAuthService service;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
       
// To override error of execution of network thread on the main thread
         StrictMode.ThreadPolicy policy = new StrictMode.ThreadPolicy.Builder().permitAll().build();
         StrictMode.setThreadPolicy(policy);
        try {
        
             service = new ServiceBuilder()
                    .provider(MagentoThreeLeggedOAuth.class)
                    .apiKey(MAGENTO_API_KEY)
                    .apiSecret(MAGENTO_API_SECRET)
                    .debug()
                    .build();

            System.out.println("Magento'srkflow");
            System.out.println();

            // Obtain the Request Token
            System.out.println("FetchingRequest Token...");
            requestToken = service.getRequestToken();
            System.out.println("GotRequest Token!");
            System.out.println();

            System.out.println("FetchingAuthorization URL...");
            String authorizationUrl = service.getAuthorizationUrl(requestToken);
            Log.d("DEBUG", authorizationUrl);
            System.out.println("GotAuthorization URL!");
            System.out.println("Nownd authorize Main here:");
            System.out.println(authorizationUrl);
            System.out.println("Ande the authorization code here");
            System.out.print(">>");

 String verifierCode =((EditText) findViewById(R.id.editText)).getText().toString();
            Log.d("DEBUG", verifierCode);
            Verifier verifier = new Verifier(verifierCode);
            System.out.println();
            System.out.println("TradingRequest Token for an Access Token...");
            Token accessToken = service.getAccessToken(requestToken, verifier);
            System.out.println("GotAccess Token!");
            System.out.println("(if curious it looks like this: "
                    + accessToken + " )");
            System.out.println();

            OAuthRequest request = new OAuthRequest(Verb.GET, MAGENTO_REST_API_URL + "/products?limit=2");
            service.signRequest(accessToken, request);
            Response response = request.send();
            System.out.println();
            System.out.println(response.getCode());
            System.out.println(response.getBody());
            System.out.println();


        } catch (Exception e) {
            e.printStackTrace();
        }


    }


    public static final class MagentoThreeLeggedOAuth extends DefaultApi10a {
        private static final String BASE_URL = "http://192.168.1.114/Mo3/";

        @Override
        public String getRequestTokenEndpoint() {
            return BASE_URL + "oauth/initiate";
        }

        @Override
        public String getAccessTokenEndpoint() {
            return BASE_URL + "oauth/token";
        }

        @Override
        public String getAuthorizationUrl(Token requestToken) {
            return BASE_URL + "admin/oauth_authorize?oauth_token="
                    + requestToken.getToken(); //this implementation is for admin roles only...
        }

    }

public class MainActivity extends AppCompatActivity {

final String MAGENTO_API_KEY = "YOUR_MAGENTO_API_KEY";

final String MAGENTO_API_SECRET = "YOUR_MAGENTO_API_SECRET";

final String MAGENTO_REST_API_URL = "YOUR_MAGENTO_REST_API_URL";

private static Token requestToken;

private OAuthService service;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// To override error of execution of network thread on the main thread

StrictMode.ThreadPolicy policy = new StrictMode.ThreadPolicy.Builder().permitAll().build();

StrictMode.setThreadPolicy(policy);

try {

service = new ServiceBuilder()

.provider(MagentoThreeLeggedOAuth.class)

.apiKey(MAGENTO_API_KEY)

.apiSecret(MAGENTO_API_SECRET)

.debug()

.build();

System.out.println("Magento'srkflow");

System.out.println();

// Obtain the Request Token

System.out.println("FetchingRequest Token...");

requestToken = service.getRequestToken();

System.out.println("GotRequest Token!");

System.out.println();

System.out.println("FetchingAuthorization URL...");

String authorizationUrl = service.getAuthorizationUrl(requestToken);

Log.d("DEBUG", authorizationUrl);

System.out.println("GotAuthorization URL!");

System.out.println("Nownd authorize Main here:");

System.out.println(authorizationUrl);

System.out.println("Ande the authorization code here");

System.out.print(">>");

String verifierCode =((EditText) findViewById(R.id.editText)).getText().toString();

Log.d("DEBUG", verifierCode);

Verifier verifier = new Verifier(verifierCode);

System.out.println();

System.out.println("TradingRequest Token for an Access Token...");

Token accessToken = service.getAccessToken(requestToken, verifier);

System.out.println("GotAccess Token!");

System.out.println("(if curious it looks like this: "

+ accessToken + " )");

System.out.println();

OAuthRequest request = new OAuthRequest(Verb.GET, MAGENTO_REST_API_URL + "/products?limit=2");

service.signRequest(accessToken, request);

Response response = request.send();

System.out.println();

System.out.println(response.getCode());

System.out.println(response.getBody());

System.out.println();

} catch (Exception e) {

e.printStackTrace();

}

public static final class MagentoThreeLeggedOAuth extends DefaultApi10a {

private static final String BASE_URL = "http://192.168.1.114/Mo3/";

@Override

public String getRequestTokenEndpoint() {

return BASE_URL + "oauth/initiate";

}

@Override

public String getAccessTokenEndpoint() {

return BASE_URL + "oauth/token";

}

@Override

public String getAuthorizationUrl(Token requestToken) {

return BASE_URL + "admin/oauth_authorize?oauth_token="

+ requestToken.getToken(); //this implementation is for admin roles only...

}

Congratulation now you can get data from the Magento Framework using Rest API in your Android Application…..

Shubham Agarwal 14 December 2016

. . .

Discuss on Helpdesk

2 comments

sujith Nov 16, 2016 at 6:31 am

Hi,

This is Sujith, I have tried with the code, but after getting the auth_token=””, its asking for the login page url to enter the credentials in the android, so how we can send the login “Username” and “Password to the magento platform from android”,

(After login we can authorise and get the verifier code and access token to android).

Vlad Feb 22, 2017 at 12:04 pm

Hell, what verifierCode variable represents?

Implementing Android Rest Client using the Magento REST api with Scribe Library

Leave a Comment Cancel Reply

2 comments

Message Sent!