PHP API Client documentation
- PHP >= 7.4
Below you will find which PHP client version to use depending on your PIM version.
|PIM version||REST API PHP client version||End of life|
|v2.1 - v2.2||v2.0||March 2019|
|v3.0 - v3.1||v4.0||August 2020|
|v3.2 - v4.0||v5.0||August 2021|
|v6.0 - v7.0 - SaaS||v7.0 to current latest|
Enterprise Edition and Community Edition of the client have been merged into a one and unique package. Every user shall now use the same client package. Learn about migration instructions here.
Note that our PHP client is backward compatible.
For example, if your PIM is currently a v6.0, you can still use a 1.0 version of the PHP client. The new endpoints available in v6.0 will not be available in the v1.0 of the PHP client.
api-php-client use Composer.
The first step is to download Composer:
$ curl -s http://getcomposer.org/installer | php
Run the following command to require the libraries in your project:
$ php composer.phar require akeneo/api-php-client php-http/guzzle6-adapter:^2.0 http-interop/http-factory-guzzle:^1.0
If you don't know which implementation to choose, we strongly recommend you to use Guzzle v6, as in the previous example.
#Initialization of the client
You first need to initialize the client with your credentials (client id, secret, username and password).
If you don't have any client id/secret, let's take a look at this page to create it.
require_once __DIR__ . '/vendor/autoload.php'; $clientBuilder = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://localhost/'); $client = $clientBuilder->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
You can authenticate to the client with your token/refresh token as well.
require_once __DIR__ . '/vendor/autoload.php'; $clientBuilder = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://localhost/'); $client = $clientBuilder->buildAuthenticatedByToken('client_id', 'secret', 'token', 'refresh_token');
Want to know more about authentication? It's over there.
#Make your first call
Getting a product is as simple as:
$product = $client->getProductUuidApi()->get('1cf1d135-26fe-4ac2-9cf5-cdb69ada0547'); echo $product['uuid'];