marcelojeff/php-sdk

Mercado Libre PHP SDK module

MercadoLibre's PHP SDK

This is the official PHP SDK for MercadoLibre's Platform., _(*1)

How do I install it?

   clone repository
   https://github.com/mercadolibre/php-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, _(*2)

Including the Lib

Include the lib meli in your project, _(*3)

require '/MercadoLivre/meli.php';

Start the development!, _(*4)

Create an instance of Meli class

Simple like this, _(*5)

$meli = new Meli('1234', 'a secret');

With this instance you can start working on MercadoLibre's APIs., _(*6)

There are some design considerations worth to mention., _(*7)

1. This SDK is just a thin layer on top of an http client to handle all the OAuth WebServer flow for you., _(*8)

2. There is JSON parsing. this SDK will include json for internal usage., _(*9)

3. This SDK will include curl for internal usage., _(*10)

4. If you already have the access_token and the refresh_token you can pass in the constructor, _(*11)

$meli = new Meli('1234', 'a secret', 'Access_Token', 'Refresh_Token');

How do I redirect users to authorize my application?

This is a 2 step process., _(*12)

First get the link to redirect the user. This is very easy! Just:, _(*13)

$redirectUrl = $meli->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., _(*14)

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., _(*15)

$user = $meli->authorize($_GET['code'], '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., _(*16)

At this stage your are ready to make call to the API on behalf of the user., _(*17)

Making GET calls

$params = array('access_token' => $access_token);
$result = $meli->get('/users/me', $params);

Making POST calls

$params = array('access_token' => $access_token);

  #this body will be converted into json for you
$body = array('foo' => 'bar', 'bar' => 'foo');

$response = $meli->post('/items', $body, $params);

Making PUT calls

$params = array('access_token' => $access_token);

  #this body will be converted into json for you
$body = array('foo' => 'bar', 'bar' => 'foo');

$response = $meli->put('/items', $body, $params);

Making DELETE calls

$params = array('access_token' => $access_token);
$response = $meli->delete('/questions/123', $params)

Examples

Don't forget to check out our examples codes in the folder examples, _(*18)

Community

You can contact us if you have questions using the standard communication channels described in the developer's site, _(*19)

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., _(*20)

Thanks for helping!, _(*21)