什么是API调用?
这是一篇关于 API 调用的快速入门文章。我们已经发布了关于API 端点和API 密钥的文章,如果你还没读过,请点击此处。
已定义的应用程序接口调用
API 调用或 API 请求是从客户端发送到服务的信息。您通常使用 API 密钥向端点发出 API 调用。您可以将这种调用比作寄信,而端点则充当邮箱或目标地址。
如何调用应用程序接口
要建立呼叫,您需要提供以下信息:
- 地址– 带有可选参数的 API 端点 URL
- 操作– 请求类型,如 GET 或 POST
- 页眉–用于添加详细信息、验证等。
- 可选数据(也称为有效载荷)
每个处理 API 调用的服务都会不断监听要处理的请求。
(对于网络流量,这些服务通常监听 80 或 443 端口。)这些服务会检索客户端请求,确保其中包含适当的安全数据(如 API 密钥、标头),解压缩所用的参数和数据,然后向客户端返回响应。
应用程序接口调用示例
下面是一个 API 调用示例,你可以在终端上试用(此功能已内置到 macOS 和 Linux 中):
curl https://api.github.com/repos/torvalds/linux
这将使用 GitHub REST API 返回有关 Linux 内核代码的一些信息。你可以用各种编程语言调用 API。
让我们用Postman 这个拥有出色用户界面的网络 API 平台,以更直观的方式来看看另一个例子。它是一个非常有用的工具,可用于试用公共 API。我们的示例将使用 JSON 参数和标头创建一个请求。然后,Postman 将请求数据并显示我们收到的响应。
要使用 Contentful API 检索给定空间中的所有内容类型,我们可以使用以下端点:
如果在 Postman 中以 GET 请求方式直接输入该端点,则会收到如下"401 未授权 "
状态和要求提供访问令牌的错误信息:
现在,如果使用授权选项卡或手动添加头,将访问令牌添加到请求头中,就会得到以下结果:
响应标头还会返回有关接收请求的端点的元数据,包括组织 ID 和请求来自的地区。
虽然这个示例是一个只读 API,但其他 API 也允许你向目标系统推送信息。如果您想建立一个创建或更新数据的请求,它通常看起来像下面这样:
- 将请求类型从
GET
改为POST
(或任何其他 http verb)。 - 将格式化的 JSON 数据添加到请求正文中。(JSON 是最常用的数据格式之一)。
- 将请求的Content-Type标头设置为application/json。
然后,您的数据将通过请求正文发送给服务。
总结
现在你知道如何使用 Contentful 或其他方法调用 API 了吧。需要提醒的是,API 无处不在,它为我们使用的每项技术提供动力,不仅是网站,还有您的 iOS/Android 应用程序,可能还有您的烤面包机。查看我们关于API 端点和API 密钥的其他文章。希望对你有所帮助!