The complete guide to connect a DAM to your PIM
#Define the technical stack of your App
Now that your PIM and your DAM are well prepared for their connection, it's time to dig a bit into the technical stack you are going to choose for your App.
#On the PIM side
That's the easy part. At Akeneo, we recommend using our REST API, whenever you want to connect your PIM to whatever third-party. So here you go! Use the REST API! 🚀 😉
We will never repeat it enough: the REST API is the most stable way to connect to the PIM. You won't suffer from migrations from a PIM version to another, as we guarantee we won't introduce any BC breaks in our REST API.
Also, and it is quite important to keep it in mind, the REST API is the fastest way to push and pull data from the PIM.
Not yet familiar with Akeneo App? We have a complete App guide!
You want to know everything about the REST API? Follow this guide!
Also, if you are a PHP developer, we provide a PHP Client for this REST API. So don't hesitate to use it if need be!
#On the DAM side
All DAMs are different. So you'll to need to get information on your DAM capabilities in terms of connectivity:
- Does it provide an API? Webhooks? A queuing system?
- How does the API authentication work?
- What are the API endpoints to pull assets from the DAM?
Your DAM may provide an API client too.
There are two main ways to connect a DAM and a PIM:
- Asynchronously using API or queuing systems,
- Synchronously with webhooks.
Both have their advantages and drawbacks.
For those who are not comfortable with these different ways to connect, below is a bit of literature to learn more about them.
For the other ones, you can skip this part. 😉
It is the most common way to connect with an external application.
APIs are great for initialization purposes. But their main drawback lays in the fact you'll need a polling mechanism in order to monitor if something changed in the application.
In other words, you'll need to regularly ask which were the last updated DAM assets, in order to synchronize them with the PIM.
Queuing systems offer the possibility to get closer to real-time and are run asynchronously, protecting your App from too many simultaneous requests.
The updated DAM assets are published as messages in the queuing system.
Then the App will consume these messages.
With webhooks, the DAM will send newly created assets and updated asset values to your App. It allows you to have some kind of "real-time" asset synchronization between your DAM and your PIM.
The biggest drawback is to ensure that your App and your PIM won't suffer from too many HTTP requests.
It could lead to a crash of one of these applications (or they could just ignore your messages) and sometimes could create latency on the DAM side (if it is waiting from a webhook response).
So be careful with that!
If a problem occurs when transforming the DAM asset or sending it to the PIM, the message is lost.
You can get around this problem using a queuing system that will register webhook requests and consume them.
Firewalls can block webhooks so you may need a specific configuration of your firewall or find another strategy.
#To keep in mind!
As mentioned above, automation can be implemented in many ways. It totally depends on your DAM capabilities.
When you use an asynchronous method to connect, you will need to synchronize your assets between your DAM and your PIM on a regular basis. Depending on your DAM and PIM users' needs, this synchronization may be needed every 5 minutes, every hour or every week. Choose this frequency very carefully as it is crucial. It is a compromise between:
- a frequent synchronisation so that your DAM and PIM users can work efficiently,
- but not too frequent as it can have an impact on performances of your overall system.
You should avoid having too many calls to the PIM REST API and process only the data you need. This is why the DAM attribute selection is really important.
For queuing systems and webhooks, you need to send all messages related to assets. Then, in the App, filter them to keep only DAM assets that are related to products that you want in the PIM (see Pre-requisites).
If you are using an API in the DAM, please make sure to only query the modified assets since the last successful synchronization, in order to avoid synchronizing twice the exact same asset.
Also, some APIs have a rate limit so feel free to check what is the best for you.
Scaling is probably the most complicated part to check.
You should process DAM assets one by one or by groups but never fetch all of the DAM assets and then process them at once.
Test and monitor your system for potential memory leaks on long-running processes.
If the memory is not stable (meaning it returns to a base after each batch call), it will alter performances and could lead to crashes.
One of the best ways to enhance your App performance is to limit the number of I/O calls to your infrastructure (HTTP requests to the API, database queries, etc...).
For example, it is better to patch assets using bulk requests than using multiple single patches. It will limit the number of REST API calls.
You can also implement a cache system for the PIM asset structure (asset family and asset attribute) to avoid using an REST API call each time you need it.
Keep in mind that one of the most efficient ways to enhance your App performance is to be able to scale (see above).
You should handle errors on DAM and PIM sides (unavailable server, authentication error, ...).
Here are the client errors that you can have on the PIM side, with our PHP client.
If you are creating/updating multiple assets at once, the REST API will return a list of errors for each attribute that couldn't be created or updated successfully.
You'll need to find a way to run the calls again for the assets that have not been synchronized.
As already stated in the introduction, we provide a skeleton to inspire you when writing your App.
It is fueled with coding best practices, so do not hesitate to have a look at it.
As a reminder, this skeleton is only supported in best effort.