README.md

Akeneo API

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

🔥 Features

• Easy typed access to your Akeneo environment via Typescript
• Built in token handling
• Helper function to get all products or product models easily

⚒️ Requirements

• node.js (LTS)

🧙 Installation

Using npm:

npm install @craftzing/akeneo-api

Using yarn:

yarn add @craftzing/akeneo-api

⚙️ Configuration

Authentication

Follow the instructions for your Akeneo version to get the required parameters:

• clientId/secret: client-idsecret-generation
• username/password: api-user-creation

Your first request

With es6 imports

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

• docs

📝 Changelog

You can check the changelog on the releases page.

🤝 Support

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.

💙 Thanks to...

• The entire Craftzing team
• All current and future contributors

🔑 License

The MIT License (MIT). Please see License File for more information.