PHPackages                             akeneo/api-php-client-ee - 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-ee

Abandoned → [akeneo/api-php-client](/?search=akeneo%2Fapi-php-client)ArchivedLibrary[API Development](/categories/api)

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

Akeneo PIM ENTERPRISE client for the API

v7.0(4y ago)13848.8k↓62.2%53OSL-3.0PHP

Since Nov 29Pushed 4y ago20 watchersCompare

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

READMEChangelog (10)Dependencies (8)Versions (19)Used By (3)

⚠️ The Client project has moved ⚠️
==================================

[](#warning-the-client-project-has-moved-warning)

TL;DR: Please use [api-php-client](https://github.com/akeneo/api-php-client) instead.

This Enterprise Edition project is now merged into the main [api-php-client](https://github.com/akeneo/api-php-client) project.
This allows easier maintainability by avoiding many duplications.

Migrate to main package
-----------------------

[](#migrate-to-main-package)

### Switch the dependency

[](#switch-the-dependency)

In `composer.json`, switch the dependency to the main [`akeneo/api-php-client`](https://packagist.org/packages/akeneo/api-php-client) package.
The main package start supporting EE features from v8.0.0.

```
{
  "require": {
    "akeneo/api-php-client": "^8.0.0"
  }
}
```

### Rename uses

[](#rename-uses)

The only breaking change is the namespace uniformization that will break `use` statements:
`Akeneo\PimEnterprise` was renamed to `Akeneo\Pim`

You can use this command to rename all your `use` statements in your project:

```
find -name '*.php' -exec sed -i 's/PimEnterprise/Pim/g' {} +
# You can add a path as first argument
```

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

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

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

Matrix compatibility:

PIM EE version(s)API PHP Client EE versionCI statusv2.0v1.0[![Build Status](https://camo.githubusercontent.com/de39f079267bfb6632b0635b98512a5242e2f86c08010d59e97887b2cac3c3f8/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742d65652e7376673f6272616e63683d312e30)](https://travis-ci.org/akeneo/api-php-client-ee)v2.1 - v2.2v2.0[![Build Status](https://camo.githubusercontent.com/4df994e3b106d8c38a8f6322e1a71b31928741dab94f7337b2da57ee9acdfdfa/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742d65652e7376673f6272616e63683d322e30)](https://travis-ci.org/akeneo/api-php-client-ee)v2.3v3.0[![Build Status](https://camo.githubusercontent.com/ba22e7d13891e25141a99ffa8dfe6f8c642aee2242d12988d5623d2c1752cf68/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742d65652e7376673f6272616e63683d332e30)](https://travis-ci.org/akeneo/api-php-client-ee)v3.0 - v3.1v4.0[![Build Status](https://camo.githubusercontent.com/1a53592946c5b73782fa27d8c234d55612a9475419b5b383a17e39ba3c41f9cb/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742d65652e7376673f6272616e63683d342e30)](https://travis-ci.org/akeneo/api-php-client-ee)v3.2 - v4.0v5.0[![Build Status](https://camo.githubusercontent.com/364750531244ec972088a3fbf563f7c24e31098e8c48f03077d145213200bc0b/68747470733a2f2f7472617669732d63692e6f72672f616b656e656f2f6170692d7068702d636c69656e742d65652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/akeneo/api-php-client-ee)v5.0v6.0-v6.0v7.0--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 >= 7.4
- 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-ee` uses [Composer](http://getcomposer.org). The first step to use `api-php-client-ee` 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-ee php-http/guzzle6-adapter:^2.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/security.html#authentication) to create it.

```