vcoud/mercadolibre

Mercadolibre SDK Composer Package

1.0.1 2016-10-14 06:36 UTC

This package is not auto-updated.

Last update: 2024-04-27 17:26:37 UTC


README

Latest Stable Version mercadolibre-sdk

MercadoLibre's PHP SDK Composer Package

This is a fork of MercadoLibre's PHP Sdk, we only make it easy to implement on laravel projects

How do I install it?

   composer require vcoud/mercadolibre

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

Create an instance of Meli class

Simple like this

use Vcoud\Mercadolibre\Meli;

$meli = 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 JSON parsing. this SDK will include json for internal usage.

  3. This SDK will include curl for internal usage.

  4. If you already have the access_token and the refresh_token you can pass in the constructor

$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.

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

$redirectUrl = $meli->getAuthUrl("http://somecallbackurl",Meli::$AUTH_URL['MLB']); //  Don't forget to set the autentication URL of your country.

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.

$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.

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

Making GET calls

$params = array('access_token' => $access_token);
$result = $meli->get('/users/me', $params); 
 #If you wish , you can get an associative array with param $assoc = true Example:
$result = $meli->get('/users/me', $params, true); 

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)