A Node Rest Client for the Akeneo PIM
npm install @craftzing/akeneo-api
!Software License
!npm (scoped)
This is an unofficial Node client for the Akeneo PIM REST API.
More info at Akeneo REST API reference
Note: not all endpoints are implements. Mostly only the GET are available. YMMV
- Easy typed access to your Akeneo environment via Typescript
- Built in token handling
- Helper function to get all products or product models easily
- node.js (LTS)
Using npm:
``sh`
npm install @craftzing/akeneo-api
Using yarn:
`sh`
yarn add @craftzing/akeneo-api
Follow the instructions for your Akeneo version to get the required parameters:
- clientId/secret: client-idsecret-generation
- username/password: api-user-creation
With es6 imports
`js
import client from '@craftzing/akeneo-api';
const akeneo = client({
url,
username,
password,
clientId,
secret,
// Optionally you can also pass in axiosOptions which will be passed to the Axios instance
});
console.log(await akeneo.productModel.getAll({}));
``
- docs
You can check the changelog on the releases page.
If you have a problem with this library, please file an issue here on GitHub.
If you have other problems with Akeneo not related to this library, you can contact their Customer Support.
- The entire Craftzing team
- All current and future contributors
The MIT License (MIT). Please see License File for more information.