The Yapla Platform is open and allows automatic communication with other external software. Different techniques are used to synchronize data between different systems.
- APIs - Version 1.0.0 and Version 2.0.0 (offer different endpoints)
- Webhooks - Add a webhook article
- Excel Import - Manually import data into Yapla using a wizard.
- Excel Export - Export data manually to reintegrate it into an external system.
The Yapla API allows access to several Yapla functions from an external program. Version 2.0 of the API is RESTful compatible, using HTTP requests to obtain, place, publish and delete data. This technique makes it possible to exchange any type of data with any external system connected to the Internet via the HTTP protocol. For more information: https://app.swaggerhub.com/apis/yapla/yapla/
A webhook is an HTTP callback function, defined by a Yapla user, that retrieves data from an event. For example, it is possible to configure a webhook in Yapla that makes an HTTP call to an external system each time a member's record is modified.
The called server, via a URL, receives a JSON structure containing all the information associated with the event. Calls can be secured by encrypting communications with an SSL certificate (HTTPS) from the called server.
This tool is usually used during the initial configuration of the platform.
At any time, it is possible to export all the data of the members of a Yapla account. Simply use the "Export excel" button in the Members list.
HOW TO RECEIVE DATA FROM OUTSIDE TO YAPLA
The best way to synchronize members of an existing system with Yapla is to take the following steps:
- A manual synchronization that takes all the members at a specific time to bring them back into Yapla.
- After this first step, the external system must use the Yapla API to send the data of a specific member for each creation or update. This way, Yapla always has the latest data from the external system.
HOW TO SEND DATA FROM YAPLA TO THE EXTERNAL SYSTEM
The principle is the same:
- the first step is to feed the existing members into the external system via an Excel export.
- After this first step, you just have to configure a webhook in Yapla that will call the external system at the two following events: "Create a member" and "Edit a member".
It is possible to maintain Yapla and an external system synchronized at all times. However, a protection mechanism against infinite loops must be in place. Specifically, member modifications sent by Yapla must not be returned to Yapla.
If you have any questions on this topic, please contact email@example.com..