ShareCRM Help Center

https://help.sharecrm.com/
Admin
ShareCRM Help Center is a comprehensive documentation portal for ShareCRM, a customer relationship...
Tokens:288,455
Snippets:4,964
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Create Interface Request Example

Source: https://help.sharecrm.com/30efe/54171/953f0

Example of a POST request to create data in the ERP system. It supports JSON format and requires authentication token.

```shell
curl --location --request POST 'http://MyDoman/path/create' \
--header 'Content-Type: application/json' \
--header 'token: TOKEN' \
--data-raw '{   "objAPIName": "APIName of ERP-side object",   "masterFieldVal": {     "Key1": "value1",     "Key2": "value2",     "Key3": "value3"   },   "detailFieldVals": {     "Detail apiName1": [       {         "Key4": "value4",         "Key5": "value5",         "Key6": "value6"       }     ],     "Detail apiName2": [       {         "Key4": "value7",         "Key5": "value8",         "Key6": "value9"       }     ]   } }'
```

--------------------------------

### Batch Query Request Example

Source: https://help.sharecrm.com/30efe/54171/953f0

Example of a GET request to query ERP data in batches. Supports various response formats like JSON, XML, and text.

```http
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
```

--------------------------------

### Single Query Request Example

Source: https://help.sharecrm.com/30efe/54171/953f0

Example of a GET request to query a single ERP data record by its ID. Includes an option to fetch detailed information.

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

--------------------------------

### Create Interface Response Example

Source: https://help.sharecrm.com/30efe/54171/953f0

Example JSON response structure for the create interface, indicating success or error codes and data identifiers.

```json
{   "code": "Error return code",   "message": "Error message",   "data": {     "masterDataId": "dataid",     "detailDataIds": {       "Key10": "value10",       "Key11": "value11",       "Key12": "value12"     }   } }
```

--------------------------------

### Single Query Response Example (JSON)

Source: https://help.sharecrm.com/30efe/54171/953f0

Example JSON response structure for a single query request, detailing the object's master and detail fields.

```json
{
  "code": "Error return code",
  "message": "Error message",
  "data": {
    "objAPIName": "APIName of ERP-side object",
    "masterFieldVal": {
      "Key10": "value10",
      "Key11": "value11",
      "Key12": "value12"
    },
    "detailFieldVals": {
      "Detail apiName1": [
        {
          "Key13": "value13",
          "Key14": "value14",
          "Key15": "value15"
        }
      ],
      "Detail apiName2": [
        {
          "Key13": "value16",
          "Key14": "value17",
          "Key15": "value18"
        }
      ]
    }
  }
}
```

--------------------------------

### Update Interface Request Example

Source: https://help.sharecrm.com/30efe/54171/953f0

Example of a POST request to update existing data in the ERP system. Similar to create, it uses JSON and requires an authentication token.

```shell
curl --location --request POST 'http://MyDoman/path/update' \
--header 'Content-Type: application/json' \
--header 'token: TOKEN' \
--data-raw '{   "objAPIName": "APIName of ERP-side object",   "masterFieldVal": {     "Key1": "value1",     "Key2": "value2",     "Key3": "value3"   },   "detailFieldVals": {     "Detail apiName1": [       {         "Key4": "value4",         "Key5": "value5",         "Key6": "value6"       }     ],     "Detail apiName2": [       {         "Key4": "value7",         "Key5": "value8",         "Key6": "value9"       }     ]   } }'
```

--------------------------------

### GET Request URL Formats

Source: https://help.sharecrm.com/dc072/ec841/8cc36/7c8ac/6451c

Examples of GET request URL formats for the common handle push data endpoint, showing variations with and without a 'string' segment.

```text
https://www.fxiaoke.com/open/callcenter/common/handle/pushData/get/{fsEa}/{eventType}/{callType}
```

```text
https://www.fxiaoke.com/open/callcenter/common/handle/pushData/get/string/{fsEa}/{eventType}/{callType}
```

--------------------------------

### Example Data JSON Format

Source: https://help.sharecrm.com/d8fc9/17217/992ab/86af6

Illustrates the initial JSON structure for approval instances before processing.

```json
{ 
  “instanceList” : [ { 
    “task_name” : “Single Approver”,
    “reply_user” : “lucy”,
    “action_type” : “Approved”,
    “opinion” : “ok”,
    “span” : { 
      “task_name” : { 
        “colspan” : 1,
        “rowspan” : 2 
      }
    }
  }, { 
    “task_name” : “Single Approver”,
    “reply_user” : “tom”,
    “action_type” : “Approved”,
    “opinion” : “Yes”,
    “span” : { 
      “task_name” : {
        “colspan” : 1,
        “rowspan” : 0 
      }
    }
  }, {
    “task_name” : “Joint Approval”,
    “reply_user” : “scott”,
    “action_type” : “Approved”,
    “opinion” : “”,
    “span” : {
      “task_name” : {
        “colspan” : 1,
        “rowspan” : 1 
      }
    }
  } ] 
}
```

--------------------------------

### Proceed to API Configuration

Source: https://help.sharecrm.com/30efe/5848f/80fa3/62c30

After retrieving object fields, click Next Step to proceed to API configuration. If no changes are needed, click Exit. Repeat for other objects.

```text
Click Next Step to proceed to API configuration; if no changes are needed click Exit. Repeat this process for other objects. After completion the page looks like this:
```

--------------------------------

### Generic SSO Configuration

Source: https://help.sharecrm.com/-/search?_page=9&q=Channel+customer+acquisition

Configure the app URL for Single Sign-On (SSO) into the ShareCRM main page using OAuth 2.0. This example demonstrates a generic SSO setup.

```javascript
/**
 * author: ajman
 * Generic SSO
 */
log.info
```

--------------------------------

### Create and Save K3Cloud Sales Order

Source: https://help.sharecrm.com/30efe/67d25/0dfdc/707eb

This example shows how to construct and save a sales order in K3Cloud. It includes setting up order details, material information, and finance details.

```Groovy
String baseUrl = "http://172.31.100.60/K3Cloud/"
String save = "Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save.common.kdsvc"
Map headers = ["Content-Type": "application/json; charset=utf-8"]
Map body = [:]

// Get sales order from CRM context
Map salesOrderMap = context.data
log.info("Order:" + json.toJson(salesOrderMap))

// Get first sales order product
Map salesProductMap = ((List)context.details.SalesOrderProductObj)[0]
log.info("Order product:" + salesProductMap)

// Get product by ID
def (error, productData, errorMessage) = object.findById("ProductObj", salesProductMap.product_id as String)
log.info("product:" + productData)

// Create order model
Map model = [: ]
// Required fields
model.put("FBillTypeID", ["FNumber": "XSDD01_SYS"])
model.put("FSaleOrgId", ["FNumber": "003"])
model.put("FCustId", ["FNumber": "4326rtyu"])
model.put("FDate", "2020-05-22 00:00:00")
model.put("FSalerId", ["FNumber": "88888"])
model.put("FSaleDeptId", ["FNumber": ""])
model.put("FBillNo ", salesOrderMap.name) // Order number

// Order detail
Map material = [: ]
material.put("FMaterialId", ["FNumber": productData.product_code])
material.put("FUnitID", ["FNumber": "Pcs"])
material.put("FQty", salesProductMap.quantity)
material.put("FTaxPrice", salesProductMap.sales_price)
model.put("FSaleOrderEntry", [material])

// Finance info
Map finance = [: ]
finance.put("FSettleCurrId", ["FNumber": "PRE001"])
finance.put("FExchangeTypeId", ["FNumber": "HLTX01_SYS"])
finance.put("FExchangeRate", 1)
model.put("FSaleOrderFinance", finance)

body.put("parameters",["SAL_SaleOrder", json.toJson(["Model":model])])
log.info(json.toJson(model))

def (error, data, errorMessage) = Fx.http.post(baseUrl + save, headers, body)
log.info(data)
```

--------------------------------

### Standard API Response Example (K3Cloud)

Source: https://help.sharecrm.com/30efe/67d25/0dfdc/707eb

Illustrates a successful response from a K3Cloud channel API call, including master and detail object IDs.

```JSON
{
  "code": 0,
  "data": {
    "masterDataId": "12345",
    "detailDataIds": {
      "detail1": ["67890"],
      "detail2": ["11223"]
    }
  }
}
```

--------------------------------

### Yunzhijia API Endpoint Example

Source: https://help.sharecrm.com/30efe/5848f/b6a7c/6e708

This is an example of the Yunzhijia API endpoint for generating tasks. Ensure you include the 'accessToken' parameter.

```URL
https://www.yunzhijia.com/gateway/newtodo/open/generatetodo.json?accessToken=
```

--------------------------------

### Hutool User Settings Configuration

Source: https://help.sharecrm.com/30efe/5848f/415f0/95f90

Example configuration for user settings using Hutool's user.setting file. Includes username and password for security.

```properties
# user.setting
# Security configuration
username=admin
password=1234qwer

```

--------------------------------

### Yunzhijia To-Do Push URL Parameters Example

Source: https://help.sharecrm.com/30efe/5848f/b6a7c/6e708

When pushing to Yunzhijia, include required URL parameters. This example shows the structure with placeholders for API name, data ID, and tenant ID.

```URL
https://www.fxiaoke.com/erp/syncdata/open/oa/authorizeWeb/webhook/{apiName}/{dataId}/{tenantId}
```

```URL
https://www.fxiaoke.com/erp/syncdata/open/oa/authorizeWeb/webhook/#F037/#F015/#F028
```

--------------------------------

### MID Substring Function

Source: https://help.sharecrm.com/d8fc9/6bad9/44dde/06a98/4367a

Extracts a substring from the middle of a string, starting at a specified position and for a specified number of characters. The starting position is 1-based.

```Formula
MID(text, start_num, num_chars)
```

```Formula
MID("dog days and dog nights", 10, 3)
```

--------------------------------

### Example JSON Response for Success

Source: https://help.sharecrm.com/dc072/ec841/8cc36/7c8ac/6451c

An example of a successful response structure from the pushData endpoint, including error code, event type, result, and trace message.

```json
{
  "errorCode": 0,
  "errorMessage": "Success",
  "data": {
    "eventType": "popThird",
    "result": "https://www.fxiaoke.com/open/cc/?code=2010&msg=..."
  },
  "traceMsg": "callcenter-provider Server: 10.124.68.61, env: fstest-gray, traceId: fs-eservice-gray/639c1d0239fcbd0001695d52"
}
```
Tokens:
Raw