Data supply for shops, websites and apps
Tips for the implementation of REST API connections
Let's assume you have a PIM system and want to supply your own shops, websites or apps with data from it. There is probably no longer a big question as to how the connection is realized technologically, the REST API interface has firmly established itself here and there are good reasons for this. In the past, connections were made using XML or database interfaces; this is hardly the case today, especially when it comes to connecting to your own systems. Today, even systems and portals of business partners are often connected directly via REST API interfaces.
Requirements of shops, websites and apps
The requirements relate to the technology on the one hand and the content on the other. The REST API technology can be assumed. In principle, it is then necessary to clarify how the content of the services is structured, whether delta transmission is necessary and how security and authentication are guaranteed.
The content to be transferred can be derived from the agency's wireframes. On the one hand, the content concerns the information that is displayed or used for full-text search, for example images, texts, features, product relationships and keywords. It should be noted that the content can be specific depending on the product area; not every product is described in the same way. And secondly, information on the control system, for example the language/country ("locales"), the range of items, navigation using categories, faceted search and possibly prices.
Tip: It should be easy for the user to customize all of the above content in the PIM, whether for display or control purposes. This ensures that no intervention in the backend of the CMS is necessary, which can often only be carried out by the agency.
REST-API services - customized or standard?
"Customizable" services have the advantage that the services can be provided according to individual requirements, which also depend on the CMS or store system.
Standard services have the advantage that they are immediately available.
Tip: Configurable services are preferable if they are easy to configure and quickly available. Make sure that the documentation is delivered with the service.
The operating phase
The implementation phase is all about an MVP. Things get exciting when the operating phase begins. Performance, security and stability of the interface are crucial here. Performance depends on both systems, the PIM and the CMS or store system. It can be helpful to only transfer the delta, i.e. to only transfer the changes from the last update. The PIM may take longer to determine the delta, but importing and building indexes in the CMS or store system takes less time.
Tip: Plan the operating phase from the outset and consider the performance, security and stability of the interface. Question the technologies used, such as delta services, authentication techniques and secure data transfer.
Thomas Kern is Managing Director and founder of crossbase. He came up with the idea for the software and has more than 25 years of experience in PIM, MAM, print, e-commerce and everything that goes with it. As a mechanical engineer specializing in applied computer science, he can therefore provide our customers from industry with comprehensive advice.
He also advises new customers on the introduction of crossbase and is responsible for project management. His main areas of expertise in the projects are analysis, data model and ERP interface.
He also shares this knowledge with you in our blog and is happy to answer your questions:
t.kern@crossbase.de
I look forward to a personal consultation with you.
Call now +49 7031 9881-770
or send me a message
Herby Tessadri
Sales Manager and Authorized Signatory