- XML2DB API is a way how to send data for automatic processing to 3rd party apps that cannot receive or send HTTP requests.
- The overal concept is that there is a middle MySQL/MariaDB database that acts as a queue of events.
- kvik.shop than automatically sends information about orders to that database as a new record. Each change on order, payment status or user account in the shop is handled and sent to that database as a new record where one of the columns is an XML document that includes detailed information about the entity (order/payment/user account) change.
Connection with your ERP or an 3rd party app
- Thanks to the XML2DB module, you can connect the shop with an external system like ERP and automate sending orders from shop to ERP.
- The shop writes automatically all the information about new orders to a bridge database from where any external system is able to read the data and import the orders.
- The data are written automatically after an order is created in the shop. It includes all the information about the order, customer, and ordered products.
- Thanks to this indenpendent XML format, the shop is not limited just to one or a few ERPs but can be connected with any ERPs.
- We do not recommend which ERP is best for you. The decision of choosing ERP has to be based on the individual needs, goals, and preferences.
- This is also the reason why the shop has an independent API that can be used for interconnection with any system of your choice.
- You need an integrator (a software developer) that will create a connection between the shop's XML2DB API and ERP API for you. Usually, it is a script that runs periodically, reads the XML documents from the database and writes them to the chosen ERPs. It can be a software developer from the company that creates the ERPs, a third-party software developer or an agency or the seller's employee.
- When you choose XML2DB module, you need a MySQL server where the data will be written. MySQL server may run on your own server, VPS or on a server hosting that supports MySQL.
FAQ
Can be XML2DB API used for sending order updates back to the shop?
No, XML2DB API works one way only, shop → middle database. There is REST API called App API that is designed for manipulating with the orders. This API is currently under heavy development and is planned to be released in Q2/2021.
Can be XML2DB API used for updating product details and availability from my ERP?
No, for this purpose, there is the import system. See the import section.
Can you change the XML structure exactly for my ERP needs?
Can you extend the XML with fields I need?
The XMLs contain data needed for many use-cases. In the case there is something missing for you in the current XML, we can, on your request, consider and add more information (details). Such change will be done in scope of the product development. Work will be planned based on available development capacities. The extended XML structure is defined by kvik.shop.
Why to use XML2DB and not to connect ERP to the shop just via REST API?
The purpose of XML2DB existence is to be middle storage that acts as a simple queue. The benefit over direct connections via an REST API is that the connection between the shop and ERP is asynchronous. If there is a need for a maintenance window or something goes wrong on any side. The data still flows to the middle database. It is also the way to go when your ERPs does not support communication via REST APIs.
Opening a database to 3rd party is a bad option!?
You are 100% correct that opening the database of your system to 3rd party is a very bad option. The XML2DB module doesn't require opening your database at all. It is supposed to be a separate database with separate credentials and with no access to the database of your system. It may run even on a different server if needed.
