APIBridge Pro是一款第三方外部API连接器WordPress插件,提供一种连接WordPress 与外部 API 的最简单方法,允许您轻松地向/从第三方API 获取(或发送)数据,然后使用简码或模板标签在您的 WordPress 网站上显示返回的数据。
API 数据可以输出为 JSON 字符串,存储在 PHP 变量中或自动输出为HTML。您可以轻松地将数据格式化为表格或图表以及许多其他可能性。
APIBridge Pro几乎支持所有身份验证方法,包括OAuth 2.0验证、承载令牌、基本身份验证、API 密钥和用户名/密码。
主要功能
- 将您的网站连接到外部 REST API
- 无需编码
- 无限的API 和端点
- GET、POST 和 PUT 请求
- 使用模板标签或简码输出 API 数据
- 设置查询字符串、标题和正文参数
- 缓存 API 调用
- 动态变量查询字符串、端点、标头和正文
- Base64编码授权
- 使用 XML 格式连接到 API
- 检索嵌套数据
- 格式为 HTML
- 格式化为数字
- 适用于任何主题
第三方集成
APIBridge Pro支持与其他WordPress 插件集成得非常好,允许您使用 API 做一些非常酷的事情。
- 使用 wpDataTables 来自 API 数据的图表和表格
- Gravity Forms 向 API 发送数据
- Contact Form 7 向 API 发送数据
- WPForms 向 API 发送数据
- Elementor、DIVI 和其他页面构建器
动态变量
在 APIBridge Pro中,您可以在Endpoint、Query String、Headers和Body POST 字段中手动设置值,如下所示。这些值是静态值,不会更改(除非您自己手动更改它们)。
通过动态变量,我们现在可以在 API 调用中使用变量值。要设置动态变量,需要将一个小的 PHP 代码片段添加到您的 functions.php 文件(或通过代码片段插件),以便可以捕获动态值(通常来自表单)。
动态变量打开了一个充满可能性的世界,对于捕获表单数据并将其发送到您的 API特别有用。请参阅Gravity Forms、WPForms和Contact Form 7示例以及这些使用Elementor Forms 将表单数据发送到 API 的代码片段。
使用动态变量的一些示例可能是:
- 将产品购买数据发送到您的API,其中包括用户详细信息和购买的商品
- 用户在您的网站上填写表格,表格数据将发送到您的 API
动态变量可用于查询Endpoint、Query String、Headers和Body。
查询字符串中的动态变量
查询字符串是 URL 中以问号开头的部分,看起来类似于此 URL 中的粗体文本:https://thebaseurl.com/theendpoint/ ?foo=bar&dynamic_variable=345678
查看有关如何在查询字符串中使用动态变量的文档。
端点中的动态变量
可变端点看起来像这样:https://thebaseurl.com/theendpoint/345678
查看有关如何在端点中使用动态变量的文档。
Headers中的动态变量
一个常见的例子可能是发送“授权”Header或“内容类型”。
查看有关如何在Headers中使用动态变量的文档。
Body中的动态变量
可变数据可以在 API 调用的主体(有时称为 POST 字段)中发送,也可以使用端点设置中的选项作为纯数据、JSON 编码或 URL 编码发送。它的一个常见用途是发送登录详细信息,例如用户名和密码,或将捕获的表单数据发送到 API。
查看有关如何在 body 中使用动态变量的文档。
缓存API调用
API 调用的缓存非常常见和有用,因为它有助于避免达到 API 限制并有助于提高网站的速度/性能。
如果每次加载页面时,您还调用 API 来获取一些数据,那么您网站的速度可能会受到很大影响。缓存通过将 API 数据临时保存在您自己的数据库中并仅在您设置的时间间隔后再次调用 API 来解决此问题。换一种方式; 如果您有 100 人访问您的页面(在您的缓存间隔时间内),那么只有第一个访问者会触发对 API 的调用,并且第一个调用会将数据本地保存在您自己的数据库中。随后的访问者将获得与第一次调用相同的数据,并避免对 API 的许多其他调用。
大多数 API 对其 API 的调用次数都有限制。一旦达到此限制,API 将在设定的时间段内停止返回数据,或者当您超过此限制时,它们可能会向您收取额外的 $$ 费用。缓存允许您选择间隔,从而选择每天可以调用 API 的最大次数,从而帮助您轻松避免这些限制。例如,如果您将时间间隔设置为 3600(1 小时),您只会每小时调用一次此端点或一天调用 24 次。这使得能够在任何 API 的限制内工作变得非常简单。
Pro Plugin 在设置中为每个端点添加了一个字段,让您可以轻松地在任何端点上设置缓存时间。
查看有关如何缓存 API 调用的文档。
检索嵌套数据
允许您使用数组键和索引逐步遍历多维数组数据以获取数据。这适用于模板函数和简码。
查看有关检索嵌套数据的文档。
Base64编码
一种能够轻松设置 base64 编码授权标头的方法。启用 Pro 插件后,您可以在标题中添加您的详细信息,如下所示。
无论您在 base64_encode() 函数中包装什么,都将被编码。
将数据格式化为 HTML
通过使用短代码中的“格式”属性,可以将 API 数据的输出格式化为 HTML。
首先确保在端点设置中,将结果格式设置为PHP 数组数据,然后将“格式”属性设置为html,如下所示。这会将您的整个输出包装在一个 div 中,然后还将各个 API 项目也包装在 div 标签中。
[wpgetapi_endpoint api_id='quotable' endpoint_id='random' format='html']
有关更多信息,我们的文档中有一篇关于如何将 API 数据格式化为 HTML的文章。
简码中的格式数字
如果您的 API 的输出是一个数字,您可以使用短代码中的“格式”属性对其进行格式化。
将“格式”属性设置为number_format(2),如下所示。这会将数字格式化为具有 2 个小数位。您可以格式化从 0 到您选择的任何数字,并将根据您站点的区域设置进行格式化。
[wpgetapi_endpoint api_id='binance' endpoint_id='price_of_coin' keys='price' format='number_format(2)']
此属性使用number_format_i18n的本机 WordPress 函数,如此处所示 – https://developer.wordpress.org/reference/functions/number_format_i18n/
格式
如果您的 API 支持,则添加以 XML 格式输出数据的选项。