MercadoLibre's Python SDK
This is the official Python SDK for MercadoLibre's Platform.
How do I install it?
clone repository
https://github.com/mercadolibre/python-sdk.git
How do I use it?
The first thing to do is to instance a Meli
class. You'll need to give a clientId
and a clientSecret
. You can obtain both after creating your own application. For more information on this please read: creating an application
Including the Lib
Include the lib meli in your project
Attention
Don't forget to set the authentication URL of your country in file lib/config.ini
import sys
sys.path.append('../lib')
from meli import Meli
Start the development!
Create an instance of Meli class
Simple like this
meli = Meli(client_id=1234, client_secret="a secret")
With this instance you can start working on MercadoLibre's APIs.
There are some design considerations worth to mention.
-
This SDK is just a thin layer on top of an http client to handle all the OAuth WebServer flow for you.
-
There is JSON parsing. this SDK will include json for internal usage.
-
If you already have the access_token and the refresh_token you can pass in the constructor
meli = Meli(client_id=1234, client_secret="a secret", access_token="Access_Token", refresh_token="Refresh_Token")
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:
redirectUrl = meli.auth_url(redirect_URI="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.
meli.authorize(code="the received code", redirect_URI="http://somecallbackurl")
This will get an access_token
and a refresh_token
(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
params = {'access_token' : meli.access_token}
response = meli.get(path="/users/me", params=params)
Making POST calls
params = {'access_token' : meli.access_token}
#this body will be converted into json for you
body = {'foo' : 'bar', 'bar' : 'foo'}
response = meli.post(path="/items", body=body, params=params)
Making PUT calls
params = {'access_token' : meli.access_token}
#this body will be converted into json for you
body = {'foo' : 'bar', 'bar' : 'foo'}
response = meli.put(path="/items/123", body=body, params=params)
Making DELETE calls
params = {'access_token' : meli.access_token}
response = meli.delete(path="/questions/123", params=params)
Examples
Don't forget to check out our examples codes in the folder examples
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.
Thanks for helping!