Akeneo developer – Integration
For whom ?
- Akeneo developers
Objectives
- Learn the PIM application basics
- Setup your environment
- Learn how to use Akeneo PIM API
Requirements
- Good programming experience (PHP preferred but not mandatory)
- Knowledge about HTTP.
- Docker should be installed on your laptop before the training
- Some Linux/CLI knowledge
Training program
🆕 We created a brand new training for you! Now available remotely.
As a developer, this session will allow you to discover the PIM application, to become autonomous and install the PIM on your environment, and to integrate the PIM to your project’s ecosystem with our API. This training is intended to show the attendees what is possible through our API and give them best practices, limits and tips when using it.
Integration training
This training is intended to show the attendees what is possible through our API and give them best practices, limits and tips when using it. Not using the PHP client but Postman and cURL.
Day 1
Introduction
General presentation of the training.
Introduction to Akeneo PIM
What is a PIM, what is Akeneo’s PIM, what are the key concepts. walkthrough the UI.
Akeneo general functionality description, key concepts.
Tour of Akeneo PXM suite: Franklin, Onboarder, Data Quality, Premium Connectors.
PIM structure
High level description of the ecosystem
Commercial offerings
Introduction to APIs
High level discussion about APIs, REST, web api, advantages of using API’s.
Postman & Postman collection
Install Postman, load Akeneo’s collection, run one example, show code generation for other environments (curl, php, Java, etc.)
Authentication
Akeneo Connections & credentials
Authentication process, create a connection, connection types.
Process behind Akeneo’s API authentication, authenticate on Postman, CURL code from Postman
First Akeneo API request
Simple example, for example get a list of families or attributes in two environments (Postman, Curl and PHP client)
For example: Get the categories, see the format of the response
Product retrieval 1
Basic get products, talk about the options that can be passed to the request such as number of results by default, first mention of the filters, pagination, limit of number of results, next and previous links etc.
Day 2
Product Retrieval 2
Advanced filtering options, exercise (get products updated during the last day)
Order of retrieval
Akeneo API’s deeper dive
Detailed analysis of verbs and update behaviors
Product values, Introduce how to handle locales and scope
Data Format
Error Handling
Manipulate Products
Create a new product, use example with longer input (a number of attributes),
Update one and multiple products examples
Delete a product
Add images to the product
Catalog architecture API endpoints
Introduce various API’s to deal for example with Reference entities, Categories, attributes, families, etc. E.G: Get categories. ”
Assets
APIs to create and maintain assets in detailed
Include asset families , product link rules, etc.
Day 3
Create/Update multiple products
How to efficiently import tons of products in Akeneo using the API.
How to measure, what are the best practices and the limits.
API Monitoring
Connection dashboard
Performance
Parallel calls
Insert/retrieval in bulk
Caching, etc.
How to properly retrieve entities information from the PIM in order to feed them to a Ecom platform.
Retrieving first high level entities (categories, families etc..)
Tips on how to properly code a connector.
Processes that require several API’s calls, order of calls to API’s different options
Dependencies
Performance considerations
How to iterate efficiently
Best Practices & limitation
Recommendation on API’s use
Do and dont’s
Server limits
Online Resources & Akeneo’s support
We will be talking about the partners portal, our community Slack, our github community, how to open a ticket, support coverage
Conclusions
Review of training and wrap-up