Giters

nelsongallardo / java-sdk

MercadoLibre's Java SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MercadoLibre's Java SDK

This is the official Java SDK for MercadoLibre's Platform.

How do I install it?

You can download the latest build at: http://github.com/mercadolibre/java-sdk/downloads

How do I install it using maven:

Just add to your pom the following repository

<repositories>
        ...
        <repository>
                <id>mercadolibre-snapshots</id>
                <url>https://github.com/mercadolibre/java-sdk-repo/raw/master/snapshots</url>
        </repository>
        ...
</repositories>

And then add your dependency

<dependencies>
        ...
        <dependency>
                <groupId>com.mercadolibre</groupId>
                <artifactId>sdk</artifactId>
                <version>0.0.1-SNAPSHOT</version>
        </dependency>
        ...
</dependencies>

And that's it!

How do I start using it?

The first thing to do is to instance a Meli class. You'll need to give a cl�ientId and a clientSecret. You can obtain both after creating your own application. For more information on this please read: creating an application �

Meli m = new Meli(1234, "a secret");

With this instance you can start working on MercadoLibre's APIs.

There are some design considerations worth to mention.

  1. This SDK is just a thin layer on top of an http client to handle all the OAuth WebServer flow for you.
  2. There is no JSON parsing. This is left to you. But this SDK will include gson library for� internal usage.

How do I redirect users to authorize my application?�

This is a 2 step process.

First get the link to redirect the user. This is very easy! Just:

String redirectUrl = m.getAuthUrl("http://somecallbackurl");

This will give you the url to redirect the user. You need to specify a callback url which will be the one that the user will redirected after a successfull authrization process.

Once the user is redirected to your callback url, you'll receive in the query string, a parameter named code. You'll need this for the second part of the process.

m.authorize("the received code", "http://somecallbackurl");

This will get an accessToken and a refreshToken (is case your application has the offline_access) for your application and your user.

At this stage your are ready to make call to the API on behalf of the user.

Making GET calls

FluentStringsMap params = new FluentStringsMap();
params.add("access_token", m.getAccessToken());
Response response = m.get("/users/me", params);

Making POST calls

FluentStringsMap params = new FluentStringsMap();
params.add("access_token", m.getAccessToken());
Response r = m.post("/items", params, "{\"foo\":\"bar\"}");

Making PUT calls

FluentStringsMap params = new FluentStringsMap();
params.add("access_token", m.getAccessToken());
Response r = m.put("/items", params, "{\"foo\":\"bar\"}");

Making DELETE calls

FluentStringsMap params = new FluentStringsMap();
params.add("access_token", m.getAccessToken());
Response r = m.delete("/items/123", params);

Do I always need to include the access_token as a parameter?

No. Actually most GET requests don't need an access_token and it is easier to avoid them and also it is better in terms of caching. But this decision is left to you. You should decide when it is necessary to include it or not.

Is there a JVM based SDK for my dynamic language?

Use this SDK for any jvm-based language. It should be easy and will adapt just right.

Community

You can contact us if you have questions using the standard communication channels described in the developer's site

I want to contribute!

That is great! Just fork the project in github. Create a topic branch, write some code, and add some tests for your new code.

To run the tests run make test.

Thanks for helping!

About

MercadoLibre's Java SDK