Skip to main content

API 接入指南

准备 API Key 和请求参数,发送 HTTP JSON 请求,并检查响应与重试条件

通过 API,您的业务系统可以发送 HTTP 请求调用法睿能力,并处理返回的结构化数据。本页介绍 API Key 认证、JSON 请求和响应处理;具体参数与示例见各接口文档。

服务地址

在服务地址查看基础地址,再选择法规检索或案例检索,查看对应的 HTTP 方法、请求路径、参数和完整调用示例。

接入前准备

要素说明
API Key 与权限按接入认证准备已启用的个人 API Key,并确认当前身份具有目标接口的访问权限
数据格式请求与响应均使用 JSON,字符集为 UTF-8
请求头Authorization 填写 API Key 原文,x-acs-date 每次请求重新生成;版本与请求体格式见下方请求头
请求参数从目标接口文档获取 URL 参数和请求体要求
用量按目标能力的规则计量,详见计费与用量

请求头

请求头填写说明
Authorization必填,填写 API Key 原文,省略 Bearer 前缀
x-acs-date必填,填写发起请求时的 UTC 时间,使用 ISO 8601 格式,精确到秒并以 Z 结尾,每次请求重新生成
x-acs-version必填,填写 2026-10-19
Content-TypeJSON 请求体使用 application/json
x-acs-date 格式示例为 2026-11-10T08:00:00Z。下面的 curl 命令会在发送时生成当前 UTC 时间;每次请求和重试都执行该命令,不要将 x-acs-date 保存为固定值。

使用 curl

以下模板用于发送带 JSON 正文的请求。运行前按目标接口文档完成配置。
1

设置请求地址与方法

在终端设置以下变量:
变量填写内容
FARUI_API_BASE_URL服务基础地址:https://farui.cn-beijing.aliyuncs.com
FARUI_API_METHOD目标接口的 HTTP 方法
FARUI_API_PATH目标接口的请求路径,以 / 开头
2

准备 API Key 和请求体

将目标环境的个人 API Key 保存到本机环境变量 FARUI_API_KEY,变量值只包含密钥原文。按接口文档填写 JSON 请求体,保存为 request.json,使用 UTF-8 编码。密钥管理见接入认证。
3

发送请求

curl --request "${FARUI_API_METHOD}" \
  --url "${FARUI_API_BASE_URL%/}${FARUI_API_PATH}" \
  --header "Authorization: ${FARUI_API_KEY}" \
  --header "x-acs-date: $(date -u '+%Y-%m-%dT%H:%M:%SZ')" \
  --header 'x-acs-version: 2026-10-19' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

处理响应

检查项处理方式
HTTP 状态先检查请求的 HTTP 状态,再读取响应正文
业务状态按接口文档判断业务结果;包含 success 时先检查该字段,不能仅凭 HTTP 状态判断业务成功
业务数据业务成功后按接口定义读取数据;空结果的含义见对应接口文档

重试原则

重发前先按目标接口文档确认错误是否可重试、如何关联原请求,以及重复执行可能产生的用量。接口支持调用方提供重试标识时,在首次请求设置该标识,重试同一请求时沿用原标识和参数。
响应丢失后,原请求可能已执行。重发前可先核对调用记录和积分用量,核对方法见计费与用量。