{"id":27890360,"url":"https://github.com/craftzing/node-akeneo-api","last_synced_at":"2025-05-05T10:47:10.957Z","repository":{"id":48044310,"uuid":"343802168","full_name":"craftzing/node-akeneo-api","owner":"craftzing","description":"This is an unofficial Node client for the Akeneo PIM REST API.","archived":false,"fork":false,"pushed_at":"2024-01-09T14:39:05.000Z","size":1104,"stargazers_count":9,"open_issues_count":2,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-17T04:48:40.370Z","etag":null,"topics":["akeneo","javascript"],"latest_commit_sha":null,"homepage":"https://craftzing.github.io/node-akeneo-api/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/craftzing.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-02T14:29:03.000Z","updated_at":"2024-03-13T10:58:19.000Z","dependencies_parsed_at":"2023-02-10T21:40:11.667Z","dependency_job_id":null,"html_url":"https://github.com/craftzing/node-akeneo-api","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftzing%2Fnode-akeneo-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftzing%2Fnode-akeneo-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftzing%2Fnode-akeneo-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftzing%2Fnode-akeneo-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/craftzing","download_url":"https://codeload.github.com/craftzing/node-akeneo-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252485891,"owners_count":21755823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["akeneo","javascript"],"created_at":"2025-05-05T10:47:10.405Z","updated_at":"2025-05-05T10:47:10.951Z","avatar_url":"https://github.com/craftzing.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Node Akeneo API](https://github.com/craftzing/node-akeneo-api/raw/master/art/banner.jpg)](https://craftzing.com)\n\n[![Quality assurance](https://github.com/craftzing/node-akeneo-api/actions/workflows/quality-assurance.yml/badge.svg?branch=master)](https://github.com/craftzing/node-akeneo-api/actions/workflows/quality-assurance.yml)\n[![Code style](https://github.com/craftzing/node-akeneo-api/actions/workflows/code-style.yml/badge.svg?branch=master)](https://github.com/craftzing/node-akeneo-api/actions/workflows/code-style.yml)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/90013a42a4dce3766813/test_coverage)](https://codeclimate.com/github/craftzing/akeneo-api/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/90013a42a4dce3766813/maintainability)](https://codeclimate.com/github/craftzing/akeneo-api/maintainability)\n![Software License](https://img.shields.io/github/license/craftzing/node-akeneo-api)\n[![js-airbnb-style](https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg)](https://github.com/airbnb/javascript/)\n![npm (scoped)](https://img.shields.io/npm/v/@craftzing/akeneo-api)\n\n# Akeneo API\n\nThis is an unofficial Node client for the Akeneo PIM REST API.\n\nMore info at [Akeneo REST API reference](https://api.akeneo.com/api-reference-index.html)\n\nNote: not all endpoints are implements. Mostly only the GET are available. YMMV\n\n## 🔥 Features\n\n- Easy typed access to your Akeneo environment via Typescript\n- Built in token handling\n- Helper function to get all products or product models easily\n\n## ⚒️ Requirements\n\n- node.js ([LTS](https://nodejs.org/en/about/releases/))\n\n## 🧙 Installation\n\nUsing npm:\n\n```sh\nnpm install @craftzing/akeneo-api\n```\n\nUsing yarn:\n\n```sh\nyarn add @craftzing/akeneo-api\n```\n\n## ⚙️ Configuration\n\n### Authentication\n\nFollow the instructions for your Akeneo version to get the required parameters:\n\n- clientId/secret: [client-idsecret-generation](https://api.akeneo.com/documentation/authentication.html#client-idsecret-generation)\n- username/password: [api-user-creation](https://api.akeneo.com/documentation/authentication.html#api-user-creation)\n\n### Your first request\n\nWith es6 imports\n\n```js\nimport client from '@craftzing/akeneo-api';\n\nconst akeneo = client({\n  url,\n  username,\n  password,\n  clientId,\n  secret,\n  // Optionally you can also pass in axiosOptions which will be passed to the Axios instance\n});\n\nconsole.log(await akeneo.productModel.getAll({}));\n```\n\n## 📚 Docs\n\n- [docs](https://craftzing.github.io/node-akeneo-api/)\n\n## 📝 Changelog\n\nYou can check the changelog on the [releases](https://github.com/craftzing/node-akeneo-api/releases) page.\n\n## 🤝 Support\n\nIf you have a problem with this library, please file an [issue](https://github.com/craftzing/akeneo-api/issues/new) here on GitHub.\n\nIf you have other problems with Akeneo not related to this library, you can contact their [Customer Support](https://www.akeneo.com/support/).\n\n## 💙 Thanks to...\n\n- [The entire Craftzing team](https://craftzing.com)\n- [All current and future contributors](https://github.com/craftzing/node-akeneo-api/graphs/contributors)\n\n## 🔑 License\n\nThe MIT License (MIT). Please see [License File](/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcraftzing%2Fnode-akeneo-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcraftzing%2Fnode-akeneo-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcraftzing%2Fnode-akeneo-api/lists"}