[Closed] Everything about the integrated REST API interface

This thread is about all topics related to the integrated online store interface for the WooCommerce, Shopware and Gambio store systems. Questions about extensions to the existing store systems are welcome here, for example about new fields from the store system or from extensions or about new functions for a store interface.

Published articles on the REST API interface

• Online store interfaces in the gFM Business ERP software
• Extend online store REST API in gFM Business
• Importing orders from WooCommerce into FileMaker (for developers)

The integrated REST API interface can also be expanded to include other online shop systems. There is exactly one REST API script in gFM Business for each store system, which contains all the commands for the interface functions.

Expansion of the interface to include a new store system

The basic principle of how the interface works internally is explained in the second article linked above. The basic principle for integrating an online store into the integrated interface is as follows:

• Analysis of the data structure of the store REST API. There is usually an overview of all orders (1, e.g. /api/orders), and there is usually a detailed view of an order (2, e.g. /api/orders/12334). The script therefore first collects all order numbers from the overview (1) and then merges the collection of all data in the detailed view (2) for the import in an execution loop.
• Documentation of field names in the online store. These must then be adapted in the script in the next step.
• The easiest way: Duplicating an existing REST API script another store system with the most suitable data structure
• Customize the field names in the new REST API script to the field names of the new store system
• Extension of the scripts [dlg.REST_selection_customers], [dlg.REST_selection_orders] and [dlg.REST_selection_article] for script call for new store system.
• Adding the new master store system in table [REST_API_Master]
• Adding a new online store in the REST-API settings of gFM-Business, perform connection test.

The login script [REST.Query] can in most cases also be used for all other store systems and generally requires no customization.