https://help.smartchart.cn/en/docs/6.DataServices/ Recent content on Smartchart开发手册 Hugo -- gohugo.io https://help.smartchart.cn/en/docs/6.DataServices/DataServiceSettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/DataServiceSettings/ Introduction # SmartChart datasets can be exposed as independent API microservices. By configuring user whitelists and tokens, external systems can query SmartChart dataset data via GET/POST requests. This makes SmartChart not just a visualization platform, but a lightweight data API gateway. Permission Settings # Account Access # Super admin can find “Service Configuration” in the user icon dropdown menu Configure API users (must exist in user settings): { "test": { "token": "smartchart" }, "test2": { "token": "smartchartxxx", "host": ["10. https://help.smartchart.cn/en/docs/6.DataServices/DataServiceAPI/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/DataServiceAPI/ Encrypted API Request (Recommended) # “secret_key” is the admin’s “token” in API service settings Content-Type: application/x-www-form-urlencoded GET Request # /echart/dataset_api/?visitor=xxx&token=xxx&type=xxx&stamp=xxxxx&param={"xx":"xxx"} Parameters: visitor: username type: dataset ID stamp: timestamp (milliseconds since 1970) token: SHA1(secret_key + stamp + visitor + type) param: query parameters (optional), JSON string Response: { "data": [[]], "result": "success", "maxpg": 1, "pg": 1 } data: 2D array, first row is header result: success or error maxpg/pg: Fixed at 1 for GET (no pagination) POST Request # For backend scheduled data sync. https://help.smartchart.cn/en/docs/6.DataServices/DataReceiveAPI/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/DataReceiveAPI/ POST Request # url: /echart/dataset_api/ Content-Type: application/x-www-form-urlencoded Request parameter data # { "visitor": "xxx", "token": "xxx", "stamp": "xxxxx", "type": "xxx", "ds": [["A","B"],["a1","b1"],["a2","b2"]], "update": 0 } Parameter Description # visitor: username type: dataset ID stamp: timestamp (milliseconds since 1970) token: SHA1 encrypted, token=SHA1(secret_key + stamp + visitor + type) update: 0=insert, 1=update ds: 2D array or refer to data filling/update format “secret_key” is the admin’s “token” in API service settings https://help.smartchart.cn/en/docs/6.DataServices/DataDownload/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/DataDownload/ Introduction # SmartChart provides ds_download() function to download dataset data as CSV or Excel files. Combined with button click events, enables flexible on-demand download of current query results (including filter conditions). Usage # ds_download(name, dataset, xls=0) // name: file name // dataset: 2D array or string // xls: 0=CSV (default), 1=Excel Example # Create a download button in template with a drag container: <div class="smtdrag" id="id_down1"> <button>Download Data</button> </div> Add click handler in any chart JS: $('#id_down1'). https://help.smartchart.cn/en/docs/6.DataServices/DataFilling/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/DataFilling/ Introduction # Data filling is SmartChart’s core mechanism for writing frontend user input to databases. Through ds_save(dataset_index, dataset), user form data, button-triggered data, and extracted cell data can be written to databases. After configuring the fill dataset, all write logic is controlled in frontend JS. Use Cases # Collect user input data Write processed data back to any system Build survey/questionnaire systems Analytics tracking Configuration # Create a lazy-load dataset with content: https://help.smartchart.cn/en/docs/6.DataServices/DataUpdate/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/DataUpdate/ Use Cases # Update data based on primary keys Configuration # Create a lazy-load dataset: dataset = { "table": "table_name", "id": "id", "fDict": {"name": "code", "m_age": "age"}, "sFields": ["age", "update_date"], "autoDict": {"updater": "$username", "update_date": "curdate()"} } id: Primary key field fDict: Field mapping between input and database sFields: Special fields (numeric types, functions) autoDict: Auto-submitted data Update Method # Same as data filling, add update=1: ds_save(0, dataset, 1) Data Format # // Single row dataset = {'id': 123, 'name': 'john'} // Multiple rows dataset = [{'id': 123, 'name': 'john'}, {'id': 124, 'name': 'smith'}] Composite Primary Key # dataset = { "table": "table_name", "id": "concat(a,b)", "fDict": {"id": "concat(a,b)"}, "sFields": [], "autoDict": {} } Auto-Generated Codes # "autoCode": {"order_no": "SELECT CONCAT('SCDD', DATE_FORMAT(NOW(), '%Y%m%d'), LPAD(IFNULL(CAST(SUBSTRING(MAX(order_no), 13) AS UNSIGNED) + 1, 1), 3, '0')) AS o FROM work_order WHERE order_no LIKE CONCAT('SCDD', DATE_FORMAT(NOW(), '%Y%m%d'), '%')"} Shorthand: "autoCode": {"order_no": "SCDD"} https://help.smartchart.cn/en/docs/6.DataServices/BackendAPIRefresh/ Mon, 01 Jan 0001 00:00:00 +0000 https://help.smartchart.cn/en/docs/6.DataServices/BackendAPIRefresh/ Introduction # Backend API refresh allows external systems (ETL schedulers, data pipelines) to notify SmartChart to refresh specified dashboard data caches after data is ready. More precise and resource-efficient than frontend scheduled refresh, ideal for “refresh after ETL completion” scenarios. Use Cases # ETL workflow: wait for backend data refresh, then trigger dashboard refresh Time-consuming queries: pre-refresh to ensure fast first load Users need consistently fast page load experiences Recommended: Set dataset cache time longer (e.