API资产:JSON数据导入功能详解及操作教程

  • 系统对接顾问

API资产:JSON数据导入功能详解

什么是JSON数据?

官方解释

JSON 是一种用于存储和传输结构化信息的格式,主要应用于服务器与客户端之间的数据交换。JSON通常以字符串或对象的形式出现在扩展名为 .json 的文件中。

JSON数据结构

由于JSON基于JavaScript对象文字语法,因此两者有很多相似之处。 核心元素包括:

  • 数据以 key/value 对的形式呈现。
  • keyvalue 用英文冒号分隔。
  • 数据元素用英文逗号分隔。
  • 花括号 {} 表示对象。
  • 方括号 [] 表示数组。

示例:

// 普通JSON数据格式
{"key1":"value1","key2":"value2","key3":"value3"}

// 对象嵌套数组
{"key1":"value1","key2":"value2","key3":["value3","value4","value5"]}

// 数组嵌套对象
[{"key1":"value1","key2":"value2"},{"key3":"value3","key4":"value4"}]

在线JSON工具

  1. JSON数据校验工具
  2. JSON数据对比工具

功能介绍

在轻易云数据集成平台中,API资产非常重要。如果API资产没有维护好,每次使用同一个API时都需要从零开始配置,非常耗时且容易出错。因此,开发了此功能来加快API资产的维护工作。

在开放的API文档中,几乎都会提供一个成功请求的JSON示例。过去我们需要根据字段一个个添加,但现在可以直接将JSON数据转为API资产中的请求参数,大大提高了效率。

操作教程

获取JSON数据

首先需要获取一段格式正确的JSON数据。 upl-image-previewurl=//pic.qeasy.cloud/2023-06-11/1686471057-126865-image.png

注: 如何判断JSON数据格式是否正确,可以使用 上文提到的校验工具。通常,我们可以从API文档中获取到这些数据。这里以管易ERP的开放API为例进行讲解。

导入JSON数据

新建一个API资产或打开现成的,找到“导入 JSON”按钮,将获取到的数据粘贴进去,然后点击确定,就可以看到这些参数已经转为请求参数了。 upl-image-previewurl=//pic.qeasy.cloud/2023-06-11/1686470270-629809-image.png upl-image-previewurl=//pic.qeasy.cloud/2023-06-12/1686554872-848946-image.png

注: 在前言部分提到过,键值对形式的数据在导入过程中会将键转为请求参数中的字段,而值则成为默认值。

分录子集导入

该功能不仅支持多维导入,还支持分录子集导入。选中需要导入子集的字段后点击“导入 JSON”,即可将其导入到选中字段的子集中。 upl-image-previewurl=//pic.qeasy.cloud/2023-06_11_1686470359_392354_image.png upl_image_preview_url=//pic_q_easy_cloud_/202306111686470367596223image_.png upl_image_preview_url=//pi_cq_ea_sy_clo_ud_/20_23061168470375-_3851im_age.pn_g

注: 分录子集导入功能仅支持字段类型为多行分录或者子表对象,不支持多字段同时导入。

更多系统对接方案