Download the PHP package akeneo/api-php-client without Composer
On this page you can find all versions of the php package akeneo/api-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download akeneo/api-php-client
More information about akeneo/api-php-client
Files in akeneo/api-php-client
Package api-php-client
Short Description Akeneo PIM client for the API
License OSL-3.0
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-php-client
PHP Akeneo PIM API
A simple PHP client to use the Akeneo PIM API.
Matrix compatibility:
| PIM version(s) | API PHP Client version | CI status |
|---|---|---|
| v2.0 | v1.0 |  |
| v2.1 - v2.2 | v2.0 |  |
| v2.3 | v3.0 |  |
| v3.0 - v4.0 | v4.0 - v5.0 |  |
| v5.0 | v6.0 | - |
| v6.0 | >= v7.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
- PHP >= 8.2
- Composer
Installation
We use HTTPPlug as the HTTP client abstraction layer. In this example, we will use Guzzle v6 as the HTTP client implementation.
api-php-client uses Composer.
The first step to use api-php-client is to download composer:
Then, run the following command to require the library:
If you want to use another HTTP client implementation, you can check here the full list of HTTP client implementations.
Documentation
Full documentation is available on the API website.
Getting started
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 to create it.
You can authenticate to the client with your token/refresh token as well.
Getting the token and refresh token is as simple as:
If you are developing an App, authenticate with your app token.
Get a product
Get a list of products
By getting pages
By getting a cursor
Create a product
Upsert a product
Upsert a list of of products
Headers option
You can make the client send requests with additional headers. Default client headers can be overriden.
Testing
Do note that you have to delete the composer.lock because Doctrine dependencies are loaded.
These dependencies are different in function of the PHP version running composer install.
Support
The support of this client is made in best effort by our Akeneo team.
If you find a bug or want to submit an improvement, don't hesitate to raise an issue on Github. Also, you can ask questions and discuss about the PHP client with the community in the Slack User Group.
Contributing
As this PHP client is an open-source project, all contributions are very welcome!
For more information, please consult the contributing section
All versions of api-php-client with dependencies
psr/http-message Version ^2.0
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
psr/http-message-implementation Version ^1.0|^2.0
php-http/httplug Version ^2.0
php-http/discovery Version ^1.6
php-http/multipart-stream-builder Version ^1.0
symfony/options-resolver Version ^5.4|^6.0|^7.0