Joomla4核心自带了web services接口,无需任何的开发就可以直接使用Restful 风格的API对joomla网站的数据进行操作。这让Joomla变得更加的灵活,可以实现各种需求的对接和自动化功能,默认情况下joomla就可以成为一个完美的APP的服务端。

1,Web Services API Endpoints


Joomla中文网对Joomla核心提供的API接口做了一个整理,相关的接口列表已经调用方法可以前往 https://www.apifox.cn/apidoc/shared-06ed820a-85ea-489f-9592-7e4e2e17f48a/doc-1426276查看详情。

2,获取令牌


请注意:Joomla 4 Web 服务 API 将随着 Joomla 4 的成熟而发展,但目前访问仅限于使用超级用户帐户进行集成。也就是说目前只有具有超级用户权限的用户账号才能进行接口调用。

在使用Web Services API 之前,首先需要获得用户的令牌。操作方法如下:

1,登录后。如图:

登录网站.png

2,登录成功后,点击右上角的用户信息,进入个人资料页面。如图:

进入个人资料.png

3,在用户信息页面的API 令牌选项卡中获得令牌。如图:

获取令牌.png

至此你就成功的获取了令牌。

3,测试接口


3.1 快速体验

 如果你只想粗略的感受一下API接口,你可以直接使用我们提供的在线测试环境。 https://www.apifox.cn/apidoc/shared-06ed820a-85ea-489f-9592-7e4e2e17f48a/doc-1426276 

只需要依据文档稍作配置即可查看请求的结果。

3.2 深入测试

如果你希望深入测试,你可以使用两个工具来进行测试,一个是Apifox,一个是Postman。

3.2.1 使用Apifox来测试

个人比较推荐的测试工具。具体的操作步骤如下:

  • 自行下载并安装 apifox。
  • 在本站下载栏目下 下载api接口合集文件 joomla4_API_openapi.json 并将其导入到apifox中。
  • 接下来转到接口设置界面,在前置操作选项卡中新增一个环境变量。将base_path 的值设置为 api/index.php/v1 如图:
    • APIFox设置环境变量.png
  • 在Auth选项卡上写入Joomla的认证信息。
    • 将类型设置为API key
    • 添加位置 设置为 Header(默认就是)
    • 将key 设置为:X-Joomla-Token
    • 将Value设置为:设置为上一步获得令牌
  • 截图如下:apifox授权设置.png
  • 最后,使用 GET 端点之一来测试您的端点是否连接到您的站点。下面是请求文章列表接口的一个返回截图:文章列表返回实例.png

     如果您收到 Forbidden 错误消息,您可能需要进一步检查您的设置,特别是 Auth 选项卡中的 API Token 需要将 Key 值设置为 X-Joomla-Token。

3.2.2 使用Post man来测试

这个在国内用的比较少。具体的操作步骤如下:

  • 下载并安装 Postman
  • 从 GitHub 下载Joomla 4 API 端点的 Postman 集合,其中有关于将集合导入 Postman 所需遵循的步骤的说明。
  • 安装集合后,编辑设置并粘贴到授权选项卡上的 Joomla API 令牌中。
  • 接下来转到变量选项卡并更新 base_path 变量以指向您的 Joomla 4 网站。
  • 最后,使用 GET 端点之一来测试您的端点是否连接到您的站点

apipostmancollectionconfig.gif

如果您得到一个有效的结果,您就可以开始在 Postman 中构建您自己的查询来测试 API!如果您收到 Forbidden 错误消息,您可能需要进一步检查您的设置,特别是 Authorization 选项卡中的 API Token 需要将 Key 值设置为 X-Joomla-Token。

 

 

作者: 樱木花道

Joomla程序员,从J1.5到J4.x始终都在做Joomla相关开发定制工作,有超过10年行业经验,国内Joomla扩展开发商ZMAX团队的核心成员

作者网站:ZMAX程序人

评论 (0)

  • 最新在前
  • 最佳在前

帮助中心