新手指南：如何使用API，超详细的教程来袭！🔥

从我舒适的沙发上，我可以轻松完成各种任务——网购杂货、叫外卖、导航到巴恩斯与诺尔书店，以及查看天气以决定是否待在家里更合适。虽然有些人可能认为这是懒，但我认为这方便得很。而这些便利要感谢API的力量。

APIs，现代便利的关键支持者，是将各种应用程序粘合在一起的胶水。这些编程接口允许不同平台间顺畅通信和信息共享，促进了支撑我们日常生活的集成和便利。此外，APIs承担了开发新应用所需大量后台工作，简化了创新数字工具和服务的开发过程。

我整理了一份详细的初学者指南和教程，教你如何使用API。

目录:

• [什么是API？]
• [为什么使用API？]
• [如何开始使用API]
• [如何使用API]
• [REST、GraphQL和SOAP API的不同之处]
• [API类型]
• [关于API的常见问题]

API是什么？

API充当数字中介，让不同的软件应用程序能够相互交流并共享信息。它定义了开发人员可以使用的特定方法、参数和数据格式，以便使用功能或获取应用程序或在线服务中的数据。

如图所示：

想想你常用的天气应用——它会调用API来获取实时的气象数据，并将这些信息直接发送到你的设备上。或者想想用社交媒体登录（比如Facebook）来访问另一个应用——背后有API默默地帮你安全验证身份。

为什么要用API呢？

没有API，我们只能依赖老旧的纸质地图来找到方向——我可能会经常迷路。但API让我们可以利用现有的数据源，而不是从头开始构建所有功能。比如，当你使用导航应用时，它会通过API请求实时位置数据，这些数据来自蜂窝塔和GPS卫星。

从开发者的角度看，API 提供了一条宝贵的捷径——他们可以利用预先构建的功能，从而可以专注于创造新的和创新的功能。比如说 Planefinder，一个实时追踪飞机的应用，它不需要从零开始构建自己的地图系统，而是使用了 Google 地图的 API。这使他们能够将时间和资源投入到开发 Planefinder 的独特功能上。

使用apidog，您可以轻松地让不同系统之间无缝对接，实现应用间的数据顺畅流通。当您的业务需要在不同的软件平台上共享信息时——比如将客户关系管理（CRM）系统与您的电子邮件平台连接起来——这种能力就显得特别重要。apidog 基于 API 技术，为用户提供方便的跨系统协作和数据共享功能。

Apidog 是一个 API 管理平台，它赋能您的业务系统实现无缝集成和顺畅的数据共享。借助 Apidog 强大的 API 能力，您可以轻松连接如 CRM 和邮件平台等应用程序，简化复杂的业务流程，并促进系统间有价值的协作。

开始使用API

我会给你们讲很多专业术语，所以在开始之前，这里有一些你需要了解的API相关的术语。

术语	定义
API密钥	一个唯一的字母和数字代码，用于访问API。
端点	API接收关于其资源请求的数字地址。
请求方法	使用HTTP方法（GET、POST、PUT、DELETE）告诉API你希望它做什么。
API调用	客户端（你的电脑）向服务器发起API请求的过程：
状态码	一个出现在API响应体中的数字代码，告诉你请求是否成功或失败。
API服务器	验证身份并处理API请求，然后返回适当的响应。
API响应	由API服务器生成并返回给客户端（你的电脑）的响应：

API密钥。

就像密码一样，API密钥是一串独特的字母和数字，用于访问和认证。此密钥是访问大多数API所必需的，因为它是跟踪和控制API使用的关键安全措施。就像你用密码访问应用程序一样，你需要有效的API密钥来访问和使用API，确保只有授权的用户或应用才能这样做。

(一只猫在玩线团)

在接下来的部分，我们会教你如何拿到并使用这些密钥。

API接口端点

API端点是指一个特定的URL或网址，它是API的接口，允许API与其他应用程序进行通信。这些端点作为标准化的位置，用于接收请求并返回响应。它们为用户提供了一种清晰且结构化的与API功能交互的方式，就像自动售货机上的按钮那样。

就像你在贩卖机上按下某个按钮来选择一种零食一样，你可以通过向特定URL发送请求来“触碰”一个API端点。API知道你要获取什么信息或执行什么操作，并给你相应的响应，为你提供所需的“数字士力架”。

请求方法

如图所示

为了通过一个API端点来传达你想要达成的目的，你需要使用四种特定的HTTP方法中的一个来发送请求。

• GET: 这种方法从API中获取特定的数据。

• POST: 这表明你想向服务器添加新数据。

• PUT: 此方法用来更新API上的现有资源。

• 删除: 如其所示，这用来从服务器删除现有数据。

这些请求类型也常被称为 CRUD — 创建、读取、更新和删除。许多面向公众的 API 通常只会提供 GET（读取）请求，以防止未经授权的第三方修改其数据。毕竟，谁也不想让任何人都能访问气象 API 并更改天气信息吧。

API 请求

一个 API 调用是发送请求、让 API 获取你需要的数据，然后接收响应的整个过程。简单来说，你只需要使用我们之前介绍过的 HTTP 请求方法之一发起请求。

想想在咖啡店点饮料的情况——你告诉店员你要什么，他们会将你的点单输入系统，然后把做好的饮料递给你享用。调用 API 也差不多是这样，不过没有实际的咖啡饮品。

状态代码：一些常见的状态码

当你向API发送请求时，会得到一个三位数的状态码，它会告诉你请求是否成功。以2开头的状态码表示请求成功。以4开头的状态码表示遇到了问题。这些状态码会告诉你请求的结果。

如何使用API（简单教程）

我打算用Apidog来展示一个使用API的示例。它提供用户友好的界面，是一个非常容易使用的API平台。

1. 挑选一个 API.

有数千个公共API可供使用。你可以在GitHub或Google的API Explorer等平台上搜索感兴趣的API。大多数网站会在其高级设置或开发者专区列出可用的API，通常可以在网站底部找到。

我将使用OpenAI API平台（点击访问 OpenAI 官方平台）。

2. 查看 API 文档

每个 API 都应该为你提供开始所需的文档。这通常会包含一个参考部分，详细说明你可以访问的对象、参数和端点，以及它们的具体用法。此外，通常还会有一些示例或用流行编程语言编写的“快速入门”指南，这些示例或指南解释：

• API 提供了哪些功能？
• 使用 API 时需要什么依赖或要求？
• 如何实际操作 API?

如果 API 需要密钥，你也能在文档里找到相关信息。

3. 写一份请求。

第一步：注册一个OpenAI账户
如果你还没有，可以去OpenAI平台注册一个账户。

步骤2：创建项目（可选步骤）

您已经登录了。在我们开始获取API密钥之前，您可以按项目整理它们。这可以让您更好地与团队协作，设置个性化的计费限额，并更清晰地掌握使用情况。

若要使用此功能，请点击屏幕左上角的 默认项目 按钮，然后选择 创建项目。（您也可以从这里访问组织概览页面。）

点击这里查看图片。

步骤3：生成OpenAI的API密钥

因为 OpenAI API 不免费，你需要生成一个 API 密钥，这样平台就知道你是谁，并且知道向谁收费。要生成 OpenAI API 密钥，请在屏幕右上角找到并点击 Dashboard。

这是我说过的OpenAI Playground，它有所有用来测试和开发OpenAI API的工具。看完欢迎信息弹出窗口后，你可以点击开始使用按钮继续。

这看起来像是教程或课程的一部分。

关闭弹窗，在左侧菜单中点击API密钥。

在屏幕的右上角，点击创建新的秘密密钥。请注意，只有通过手机号验证账户，你才能创建一个 API 密钥，

会出现一个弹出窗口，显示你的API密钥。我会马上向你详细介绍这些设置。

在 Name 里，为你的 API 密钥起一个适当的名字或服务 ID。

如果你创建了一个项目来管理你的API密钥，从下拉菜单中选择它。否则，你可以保持默认设置。

最后一个设置让你调整此密钥的权限：

• 所有提供对所有API功能的完全访问。
• 受限允许你选择此密钥可以访问哪些模型与任务。
• 只读阻止所有写入请求，例如，阻止任何修改数据的请求，这对于将数据拉取到外部系统非常有用。

最好将其权限设置为完成任务所需的最低权限。

一旦你调整了这些设置，点击生成密钥，平台将为你生成一个。你将无法再次看到这个密钥：现在复制并粘贴到一个安全的地方保存并妥善保存，并在下一步设置好通话后可以考虑删除它。

"（此处可添加图片描述，如源文本中有提供的话）"

一旦你点击完成按钮，新的密钥会被加入到列表里。你可以随时删除或编辑名称和权限，随时进行修改。

步骤 4：开启 API 文档和参考资料

调用和构建 API 会根据你希望使用的 API 功能特性而有所不同。为了找到并理解如何操作，你需要找到合适的步骤。

• 文档页面为你提供了 API 功能的全面概述以及如何使用这些功能的方法。这是文本生成功能的文档。
• API 参考页面包含了你需要的所有技术规范，以便将这些规范打包到请求中。这是聊天完成端点的API参考（我们将使用它来执行文本生成任务）。

要想充分利用API的所有功能，你需要逐渐熟悉这些页面。如果你遇到问题或者正在思考新的应用场景，记得随时回来看看，多学一些。

可以使用屏幕右上角的链接通过顶部右侧的链接在文档和 API 参考之间来回切换。

（图片显示的内容，点击可以查看图片）

在这个例子中，我想使用聊天完成端点，所以我将导航到对应的页面查看API参考页面。首先，我们需要复制端点URL (https://api.openai.com/v1/chat/completions) 并记住HTTP方法，本例中是POST。

第五步：新建一个请求

你可以使用Apidog发送cURL请求。Apidog是一款强大的API开发和测试工具，为开发人员提供了一系列功能和优势。就像Postman一样，Apidog允许用户发送cURL请求，这对于已经熟悉在终端或命令行中使用cURL的人来说特别有用。利用Apidog友好的用户界面和丰富的功能，你可以轻松地创建并发送cURL请求，以及其他各种请求。这使开发人员能够高效地测试API，快速发现并解决潜在问题，从而优化他们的API开发流程。

1. 通过官方文档或访问Apidog上的OpenAI API项目页面，从左侧菜单中找到并选择“Chat Completions API”端点。在新的请求页面上，按照ChatGPT的要求输入HTTP方法和端点URL。然后，在“Body”部分中，用JSON格式编写你想要发送给ChatGPT的消息。

2: 切换到“标头”标签，添加Authorization参数以用ChatGPT API进行身份验证，输入你得到的ChatGPT API密钥，然后点击“发送”按钮。

来看这张图片：

注意: 在 Apidog 中，您可以将 OpenAI 的 API 密钥存储为 环境变量名。将 OpenAI 的 API 密钥存储为环境变量名意味着您以后可以直接使用这个环境变量名，而无需反复输入 API 密钥，这很方便。

REST、GraphQL 和 SOAP API 对比

• 一个 REST（表征状态传输）API，或称为 RESTful API，是当今最常见的一种 API 形式。它基于网络，意味着信息是在线交换的。当你向 REST API 发出请求时，你会得到 API 可提供的一切数据。
• GraphQL（查询语言）API 的工作方式类似，但它只会返回你想要的特定数据，而不是获取所有数据。你可以指定所需字段，避免大量的数据交换导致的加载速度问题。GraphQL API 是相对较新的，因此不像 REST 那样普遍，但它们正在变得越来越流行。
• SOAP（简单对象访问协议）API 使用 XML（可扩展标记语言）作为通信手段。在2000年代初，SOAP API是不同软件间通信的标准化方式。由于它们比 REST 和 GraphQL 等替代方案不够灵活且复杂，自那时起它们的受欢迎程度已显著下降。

API 类别

APIs可以分为四类，每类都有其特定的用户群体和权限设置。

开放API

这些是公共API，可以让开发者访问平台的服务或数据。它们也供第三方集成使用。这里举几个例子：

• Google Maps API: 任何人都可以使用此 API 将 Google 地图集成到他们的应用程序中，以提供地图和位置服务功能。
• Notion API: 此开放 API 允许用户将 Notion 工作区与其它软件连接。
• OpenAI API: 此 API 让开发人员可以将 GPT-4 API 和 Whisper API 与其他应用程序相连。
• Discord API: 此 API 可将 Discord 频道与其他应用程序集成。

伙伴 API

这是一种专门为合作伙伴或选定的第三方实体创建的API。它们提供对某些功能或数据的有限访问，通常是为了在平台与其合作伙伴之间进行整合。这里有一些例子：

• Facebook 登录 API: 第三方应用可以使用此 API 使用户能够使用 Facebook 账号进行身份验证，从而实现轻松的登录过程。
• Airbnb 合作伙伴 API: 有意合作的第三方将由 Airbnb 的合作经理直接联系，以实施此 API，该 API 集成了外部预订和其他系统。
• eBay API: eBay 向加入 eBay 开发者计划的用户提供了多种 API，包括销售 API、购买 API、商业 API 等。

内部 API

这些还被称为私有API，由一个组织创建并用于内部用途。它们促进着内部系统之间的通信和数据交换。由于这些API是私有或专有的流程的一部分，因此通常不会对外公开。这里举一个例子：

• Amazon API: 亚马逊员工仅通过内部API共享数据，这帮助他们这些年发展壮大。

组合API

也叫编排API，复合API整合来自多个API的数据和功能。它们作为单一入口点供客户端使用，并通过统一的界面简化与多个API交互的复杂性。这里有几个例子：

• Twilio API: 此 API 集成了多种通信渠道，允许用户构建全面的通信方案。
• Salesforce API: 此 API 可在一个调用中执行多个 Salesforce 请求。

APIs 可以为你打造创新的应用和服务提供无限的机会。但如果你只是想用 APIs 来整合你的应用或自动化你的工作流程。

API FAQ

就像任何涉及代码、数据和服务器的事情一样，对于非开发者来说，理解API可能会让你感到困惑。但如果你已经看到这里，你已经做得不错了。对于仍有疑问的地方，继续阅读以获取答案。

如何通过API访问数据？

APIs 用于从服务器访问数据，而无需用户自己去寻找。但如果你想更仔细地查看数据（即，查看矩阵），你可能需要获得你所选 API 的开发者权限。

这四种类型的API接口是？

四种最常见的API类型是开放、伙伴、私有和复合API。开放API可供公众访问。伙伴API仅限特定用户或团队访问。私有API仅限公司内部使用。复合API将多个API整合为一个统一的接口。

什么是 API？

API是应用程序接口，连接不同的应用程序，让它们可以互相通信和交换数据。如果你用过手机或电脑（你肯定用过），你可能一直在用到API而自己都不知道。

如果你想自己搞一个，你先需要找到一个公开API，然后再把你的编程知识捡起来。