The purpose of this interface documentation is to clearly describe the currently supported interface methods of the ERP data synchronization platform (including three synchronization methods: actively invoking heterogeneous systems to create/modify interface push information, polling heterogeneous systems for incremental data by time period, and providing passive reception of push information from heterogeneous systems). This documentation is intended for developers to use as a basis for integration development, to avoid communication discrepancies between parties.

Interface Viewing Method: Log in to ShareCRM, navigate to Management > System Management > System Integration Management > ERP Data Synchronization > Data Synchronization Settings. After entering, under the ERP Object Management tab, create a new intermediate table object, configure the fields of the ERP-side object, and return. Click the Generate API button in the operation column on the right side of the object to view the interface format corresponding to the object.

The ERP data synchronization platform listens to ShareCRM’s MQ messages. When an Account creates/modifies business documents in ShareCRM, ShareCRM will generate MQ messages in real-time to notify the integration platform. After receiving the message, the platform actively pushes the business document data to the heterogeneous system. For interface viewing methods, refer to the ERP Data Synchronization Platform Interface Viewing/Generation Method section.

Interface Path: http://MyDoman/path/create — Please replace http://MyDoman/path/ and the address part in curl with the actual ERP access path filled in the ERP vendor settings tab.

Request Method: POST

Data Format: Supports multiple data formats such as xml, text, json, etc. It is recommended to use json format.

Request Format: Refer to the following example:

Interface Path: http://MyDoman/path/update — Please replace http://MyDoman/path/ and the address part in curl with the actual ERP access path filled in the ERP vendor settings tab.

Request Method: POST

Data Format: Supports multiple data formats such as xml, text, json, etc. It is recommended to use json format.

Request Format: Refer to the following example:

The ERP data synchronization platform actively queries the need for heterogeneous systems to provide batch and single query interfaces. Polling refers to the ERP data synchronization platform using the GET request method to periodically poll the batch query interface of the heterogeneous system to query incremental data within the time period. The minimum interval can be set to 6 minutes on the interface. For interface viewing methods, refer to the ERP Data Synchronization Platform Interface Viewing/Generation Method section.

Interface Path: http://MyDoman/path/queryMasterBatch?objAPIName=Query ERP object’s APIName&startTime=Start time of data change (unix timestamp, Unit milliseconds)&endTime=End time of data change (unix timestamp, Unit milliseconds)&includeDetail=true&offset=Record offset&limit=Number of records in the current request — Please replace http://MyDoman/path/ and the address part in curl with the actual ERP access path filled in the ERP vendor settings tab.

Request Method: GET

Return Data Format: Supports multiple data formats such as xml, text, json, etc. It is recommended to use json format.

Request Format:

GET http://MyDoman/path/queryMasterBatch?objAPIName=Query ERP object’s APIName&startTime=Start time of data change (unix timestamp, Unit milliseconds)&endTime=End time of data change (unix timestamp, Unit milliseconds)&includeDetail=true&offset=Record offset&limit=Number of records in the current request

Response Example:

Interface Path: http://MyDoman/path/queryMasterById?objAPIName=Query ERP-side object’s APIName&dataId=Data id&includeDetail=true — Please replace http://MyDoman/path/ and the address part in curl with the actual ERP access path filled in the ERP vendor settings tab.

Request Method: GET

Return Data Format: Supports multiple data formats such as xml, text, json, etc. It is recommended to use json format.

Request Format:

GET http://MyDoman/path/queryMasterById?objAPIName=Query ERP-side object’s APIName&dataId=Data id&includeDetail=true

Response Example:

After the heterogeneous system creates/modifies business documents, it pushes data to the ERP data synchronization platform in two different formats (standard format/non-standard format). In the passive reception mode of the ERP data synchronization platform, the Header parameter content of the data pushed by the heterogeneous system must follow one of the two formats: standard format/non-standard format. If the heterogeneous system uses the active push method, it is recommended to use the standard format to push data. For interface viewing methods, refer to the ERP Data Synchronization Platform Interface Viewing/Generation Method section.

Push Execution Logic: The external interface actively calls the integration platform’s push interface to push data into the integration platform’s cache. The platform will asynchronously pull data from the cache table. If writing to the cache table fails, it directly returns an error message. If pulling data from the cache fails, you need to check the data error reason in the integration platform’s data maintenance.

Note: The standard format and non-standard format are distinguished based on the format of the data pushed by the heterogeneous system. Under both formats, there are requirements for the Header parameters of the push information (the standard format requires the header to provide the data id), but the non-standard format has no requirements for the body part of the push information, while the body part of the standard format must also be provided according to the platform’s required format. See the following explanation for details:

Interface Path: https://www.fxiaoke.com/erp/syncdata/open/objdata/asyncpush

Request Method: POST

Data Format: Only supports json data format.

Request Header Parameters: (Parameters can be obtained by clicking the Generate API button on any object in the ERP object list, and entering the push interface description to view the relevant parameters)

Standard Format:

Request Format:

Interface Path: https://www.fxiaoke.com/erp/syncdata/open/objdata/asyncpush

Data Format: Supports multiple data formats such as xml, text, json, etc. It is recommended to use json format.

Request Header Parameters:

Request Format: No restrictions

Custom functions can insert/modify/query data mapping tables. Example functions are as follows:

```groovy Map header = [:] // Create data mapping Map param1 = [ “ployDetailId”: “155bd981457343f291e0edc13776217f”, // Strategy detail id, if the strategy is deleted and rebuilt, this needs to be changed “sourceObjectApiName”: “AccountObj”, // Source object apiName, if the object apiName changes, this needs to be changed “destObjectApiName”: “BD_Customer.BillHead”, // Target object apiName (virtual), if the object apiName changes, this needs to be changed “sourceDataId”: “sourceDataId123”, // Source object data id “destDataId”: “destDataId123666”, // Target object data id “sourceDataName”: “sourceDataName3666”, // Source object data name attribute “destDataName”: “destDataName66”, // Target object data name attribute “remark”: “remark1341” // Remark ] def result1 = Fx.proxy.callAPI(“erp.syncData.createSyncDataMapping”, header, param1); // [false, HttpResult(statusCode=200, content={“errCode”:”s106240000”,”errMsg”:”Success”}, bytes=null), ] s106240000 success, others fail log.info(result1)

// Update target object data id based on source object data id Map param2 = [ “sourceObjectApiName”: “AccountObj”, // Source object apiName, if the object apiName changes, this needs to be changed “destObjectApiName”: “BD_Customer.BillHead”, // Target object apiName (virtual), if the object apiName changes, this needs to be changed “sourceDataId”: “sourceDataId123”, // Source object data id “destDataId”: “destDataId123666” // Target object data id ] def result2 = Fx.proxy.callAPI(“erp.syncData.updateSyncDataMapping”, header, param2); // [false, HttpResult(statusCode=200, content={“errCode”:”s106240000”,”errMsg”:”Success”}, bytes=null), ] s106240000 success, others fail log.info(result2)

// Query whether the source object data id has a mapping relationship Map param3 = [ “sourceObjectApiName”: “AccountObj”, // Source object apiName, if the object apiName changes, this needs to be changed “destObjectApiName”: “BD_Customer.BillHead”, // Target object apiName (virtual), if the object apiName changes, this needs to be changed “sourceDataId”: [“sourceDataId123”] // Source object data ids, List ] // If you need to query whether the target object data id has a mapping relationship, change sourceDataId to destDataId. If both are passed, it will only query based on the source data id def result3 = Fx.proxy.callAPI(“erp.syncData.getSyncDataMappingBySourceDataId”, header, param3); // [false, HttpResult(statusCode=200, content={“data”:{“sourceDataId123”: {“sourceDataId”:”sourceDataId123”,”isCreated”:true,”destDataId”:”destDataId123666”,”sourceDataName”:”sourceDataName1233”,”updateTime”:1611047455451,”lastSyncStatus”:6, “destDataName”:”destDataName123”,”destTenantId”:”81138”,”sourceObjectApiName”:”AccountObj”,”destObjectApiName”:”BD_Customer.BillHead”,”sourceTenantId”:”81138”, “statusName”:”新增成功”,”id”:”aa46ed320312476485e932a1ca4b4263”,”lastSyncDataId”:”92c86fb175254e54b990bd86b6ce1145”,”status”:1}}, “errCode”:”s106240000”,”errMsg”:”Success”}, bytes=null), ] // s106240000 success, others fail // data is a Map, storing data with existing mapping relationships, key is the source data id, value is the existing corresponding relationship log.info(result3) ```