PHPackages                             akeneo/api-php-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. akeneo/api-php-client

ActiveLibrary[API Development](/categories/api)

akeneo/api-php-client
=====================

Akeneo PIM client for the API

V11.4.0(1y ago)963.4M—7.4%65[18 issues](https://github.com/akeneo/api-php-client/issues)[6 PRs](https://github.com/akeneo/api-php-client/pulls)18OSL-3.0PHPPHP >=8.2

Since Jul 11Pushed 1y ago34 watchersCompare

[ Source](https://github.com/akeneo/api-php-client)[ Packagist](https://packagist.org/packages/akeneo/api-php-client)[ RSS](/packages/akeneo-api-php-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (17)Versions (39)Used By (18)

PHP Akeneo PIM API
==================

[](#php-akeneo-pim-api)

A simple PHP client to use the [Akeneo PIM API](https://api.akeneo.com/).

Matrix compatibility:

PIM version(s)API PHP Client versionCI statusv2.0v1.0[![Build Status](https://camo.githubusercontent.com/12c4159460c4a154654f102d8d99f0360dad12d8cadf84b32921af3fd83f3139/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742e7376673f6272616e63683d312e30)](https://travis-ci.org/akeneo/api-php-client)v2.1 - v2.2v2.0[![Build Status](https://camo.githubusercontent.com/fc7b52c5d237da40d4f8da2da6a23f3293881cf4522ddf2722ab0179f4279d06/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742e7376673f6272616e63683d322e30)](https://travis-ci.org/akeneo/api-php-client)v2.3v3.0[![Build Status](https://camo.githubusercontent.com/aef7d50e3031ed7c5a4b5420a7959c159d4489686a909c154bd1c271cbe2a650/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742e7376673f6272616e63683d332e30)](https://travis-ci.org/akeneo/api-php-client)v3.0 - v4.0v4.0 - v5.0[![Build Status](https://camo.githubusercontent.com/52f91e35c749879022174783ec712f4b949b7599d6c8c35354cc8b818410a6e4/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742e7376673f6272616e63683d342e30)](https://travis-ci.org/akeneo/api-php-client)v5.0v6.0-v6.0>= v7.0--master[![CircleCI](https://camo.githubusercontent.com/9da2cbf2d08f61e0aaff631e0da5bf03343b1af77bedfbf444810e14ed679eba/68747470733a2f2f636972636c6563692e636f6d2f67682f616b656e656f2f6170692d7068702d636c69656e742f747265652f6d61737465722e7376673f7374796c653d737667)](https://circleci.com/gh/akeneo/api-php-client/tree/master)Note that our PHP client is backward compatible. For example, if your PIM is currently a v2.3, you can still use a 1.0 version of the PHP client. The new endpoints available in v2.3 will not be available in the v1.0 of the PHP client.

Requirements
------------

[](#requirements)

- PHP >= 8.2
- Composer

Installation
------------

[](#installation)

We use HTTPPlug as the HTTP client abstraction layer. In this example, we will use [Guzzle](https://github.com/guzzle/guzzle) v6 as the HTTP client implementation.

`api-php-client` uses [Composer](http://getcomposer.org). The first step to use `api-php-client` is to download composer:

```
$ curl -s http://getcomposer.org/installer | php
```

Then, run the following command to require the library:

```
$ php composer.phar require akeneo/api-php-client php-http/guzzle7-adapter:^1.0 http-interop/http-factory-guzzle:^1.0
```

If you want to use another HTTP client implementation, you can check [here](https://packagist.org/providers/php-http/client-implementation) the full list of HTTP client implementations.

Documentation
-------------

[](#documentation)

Full documentation is available on the [API website](https://api.akeneo.com/php-client/introduction.html).

Getting started
---------------

[](#getting-started)

### Initialise the client

[](#initialise-the-client)

You first need to initialise the client with your credentials client id/secret and with your user/password.

If you don't have any client id, let's take a look at [this page](https://api.akeneo.com/documentation/authentication.html) to create it.

```