跳到主要内容

API 入门

本文适合没有代码基础的读者阅读，仅简单介绍 API 的基础概念，帮助你理解接口文档中的常见配置项。

什么是 API​

API（Application Programming Interface，应用程序接口），是软件开发者将某个已经做好的功能开放给外部使用的一个窗口。外部人员无需访问源码或理解内部代码处理细节，只需要按 API 规定的格式传递一些参数，即可获取期望的数据或执行期望的操作。

例如，一个典型的 API 服务是：查询汇率信息。

https://api.frankfurter.dev/v2/rates?base=USD&quotes=CNY

打开这个地址后，系统会返回 1 美元兑换人民币的汇率。你只需要修改 base= 后面的基准币种，或修改 quotes= 后面的目标币种，再重新请求，就可以查询其他币种之间的汇率。

在这个 URL 中：

  • base=USD 表示以美元作为基准币种；
  • quotes=CNY 表示查询美元兑换人民币的汇率；
  • ? 后面是请求参数；
  • 多个参数之间使用 & 连接。

请求成功后，API 会返回 JSON 格式的数据，示例如下：

{
  "base": "USD",
  "date": "2026-06-23",
  "rates": {
    "CNY": 7.18
  }
}

其中：

  • base 表示基准币种；
  • date 表示汇率日期；
  • rates.CNY 表示 1 美元对应的人民币汇率。

这就是 API 服务：你只需要按照接口要求传递参数，服务器就会处理请求并返回结果。至于服务器内部如何获取汇率、如何计算和更新数据，你不需要关心。

API 请求的组成​

调用 API 的过程，通常称为“发起请求”。

在浏览器中打开一个接口地址，可以理解为发起了一次请求；在工作流中，则是由「发送 API 请求」节点代替你发起请求。

一次 API 请求通常由以下几部分组成。

  • API接口地址

    API 服务商提供的访问地址，也可以理解为这个功能对外开放的入口。

  • 请求方式

    常见的请求方式有 GET、POST 等。

    • GET：常用于查询数据，例如查询手机号归属地、查询企业信息。
    • POST：常用于提交数据，例如新增记录、提交表单、创建订单。

    具体使用哪种请求方式，以 API 文档说明为准。

  • 请求的参数

    参数是请求时传递给服务器的数据。

    例如在下面这个地址中，base 和 quotes 都是参数：

    https://api.frankfurter.dev/v2/rates?base=USD&quotes=CNY

  • 授权认证方式

    很多 API 不能被任何人随意调用，需要验证调用者身份。

    常见认证方式包括 key、token、appKey + sign 等。sign 通常表示签名，用于进一步验证请求是否合法。

  • Header 请求头

    Header 是请求时附带的一组信息，常用于传递认证信息、数据格式等。

    例如有些接口要求把 token 放在 Header 中。Header 的字段名不一定固定为 Authorization，也可能是 token、X-API-Key 等，具体要看接口文档。

  • Body 请求体

    Body 常用于存放要提交的数据，在 POST 请求中最常见。

    例如通过 API 向第三方系统新增一条表单数据时，表单字段名称和字段值通常会放在 Body 中。

简单理解，调用 API 时通常需要关注这几件事：

  1. 请求哪个 API 地址；
  2. 使用哪种请求方式；
  3. 传递哪些参数；
  4. 使用什么认证方式；
  5. 参数应该放在 URL、Header 还是 Body 中。

案例​

前文已经通过汇率查询接口介绍了最基础的 GET 请求。下面继续通过两个案例，说明需要配置 Header 认证和 Body 参数的 API 请求。

查询 AI 账号余额：理解 Header 认证​

有些 API 不能直接通过浏览器打开 URL 来访问，因为服务商需要先确认“是谁在调用接口”。例如，查询账号余额时，服务商必须知道当前请求属于哪个账号，才能返回对应的余额信息。

这里以 DeepSeek API 的查询余额接口为例，介绍如何通过 Header 传递认证信息。

以下接口仅用于说明 Header 认证的配置方式。阅读本文不需要实际注册或调用 DeepSeek 服务。

API地址： https://api.deepseek.com/user/balance

请求方式： GET

传递的参数： 无需传递 URL 参数。

授权认证方式： Bearer Token 认证。需要将 API Key 放在 Header 中传递。

Header 配置

参数名参数值
AuthorizationBearer 你的 API Key

其中：

  • Authorization 是用于传递认证信息的 Header 参数名；
  • Bearer 是认证类型；
  • 你的 API Key 需要替换为服务商平台中创建的真实 API Key。

简化后的请求可以理解为：

GET https://api.deepseek.com/user/balance

Authorization: Bearer 你的 API Key

在工作流的发送API请求节点中的配置如下：

请求成功后，API 会返回 JSON 格式的数据，示例如下：

{
  "is_available": true,
  "balance_infos": [
    {
      "currency": "CNY",
      "total_balance": "110.00",
      "granted_balance": "10.00",
      "topped_up_balance": "100.00"
    }
  ]
}

其中：

  • is_available 表示当前账户是否有可用于 API 调用的余额；
  • currency 表示货币类型，例如 CNY 表示人民币，USD 表示美元；
  • total_balance 表示总可用余额；
  • granted_balance 表示未过期的赠金余额；
  • topped_up_balance 表示充值余额。

通过这个案例可以看到：

有些 API 的请求地址本身很简单，也不需要 URL 参数，但仍然不能直接复制到浏览器中打开。因为这类接口需要先验证调用者身份，所以必须在 Header 中传递认证信息。

向工作表新增记录：理解 POST 请求和 Body 参数​

我们就以工作表API为例，介绍如何向表中新增一行记录。

首先来看下工作表 API V2的文档：

从API文档中可以看到，请求的方式是 POST，只需配置请求 URL 和参数即可。

授权认证方式：appKey + sign , 和参数一起，配置在 Body 中即可。

Body 提交格式：Raw（JSON），即将参数名和参数值组织成 JSON 格式后提交。相比表单式配置，这种方式通常更适合有一定技术基础的用户处理。

在工作流中发送API请求节点的配置如下，将请求的URL和参数分别配置到 URL 和Body中。

发送请求后，工作表就自动增加了一行数据。

通过这个案例可以看到：

POST 请求常用于提交数据。与前面的 GET 请求不同，新增记录时需要提交的数据通常放在 Body 中，而不是直接拼接在 URL 后面。

这篇文档对你有帮助吗？