Using contao web services you can synchronize members, categories, products, articles etc data with external sources.
Most businesses that host their website with this system, use the built-in customer database in this system as the default customer database for their business. However there are times when you may want to synchronize your customer database on this system with an external database stored in your office or a 3rd party location. Utilizing the built-in API framework you can build the relevant bridges so you can synchronize the two databases at intervals that suit your business.
This system comes with an extensive web services framework that enables you to develop your own applications that can talk in real-time with this system and retrieve almost any type of information. This article specficially will outline the steps required to build an application that enables you to synchronize your customer list between the two systems.
You will need programming skills to develop such a bridge. You can use any programming language that supports web services to write your applications in that communicate with this system.
The run-time API (application programming interface) methods provide a standardized way for SCOs to communicate with the LMS while shielding the communication implementation from the SCO developer.
Trident has built-in support for the SCORM Run-Time API. Trident contains HTML and JavaScript editors for SCOs that have content-assist for API objects and methods.
Session methods are used to initiate and terminate data communication between a SCO and an API instance. Calling a session method may change the API instance's current error code.
The Initialize("") function is used to initiate the communication session. It allows the LMS to handle LMS specific initialization issues.
The Terminate("") function is used to terminate the communication session. It is used by the SCO when the SCO has determined that it no longer needs to communicate with the LMS.
The GetValue(parameter) function requests information from the LMS. It permits the SCO to request information from the LMS, including the value of data model elements.
The SetValue(parameter1, parameter2) function is used to request the transfer to the LMS of the value of data model elements.
The Commit("") function requests forwarding to the persistent data store any data from the SCO that may have been cached by the API instance. The method can be used to guarantee that data set by SetValue() is persisted to reduce the likelihood that data is lost due to communication session interruption or abnormal session termination prior to a call to Terminate().
The GetLastError() function requests the error code for the current error state of the API instance.
The GetErrorString(parameter) function retrieves a textual description of the current error state.
The GetDiagnostic(parameter) function exists for LMS specific use and allows the LMS to define additional diagnostic information through the API instance.
The Run-Time API (application programming interface) is the communication mechanism for informing the LMS of the communication state and between a content object and the LMS (e.g., initialized, terminated, and/or in an error condition), and is used for retrieving and storing data (e.g., score and time limits) between the LMS and the SCO.
Only launched SCOs (not Assets) make use of the RTE API.
RTE/LMS implementations are responsible for providing an API instance that SCOs can use. The API instance is exposed as an object in the Document Object Model (DOM), typically as a JavaScript variable. The LMS must launch the SCO in a browser window that is a dependent window (i.e., "pop-up" window) or child frame of the browser window that exposes the API instance.
SCOs are responsible for retrieving the API instance provided by the RTE/LMS. Typically this is done, via JavaScript, by recursively searching the parent and/or opener window hierarchy until the API instance is found. The mandatory name for the object in the browser DOM that is associated with the API instance is API_1484_11.
Once a SCO finds an API instance, the SCO is required, at a minimum, to issue Initialize("") and Terminate("") API calls.
The API instance will establish a communication session with the RTE/LMS when Initialize() is called. The communication session will end when Terminate() is called.
The run-time API (application programming interface) methods provide a standardized way for SCOs to communicate with the LMS while shielding the communication implementation from the SCO developer.