使用插件扩展功能

利用我们不断增长的API Web服务插件库。

节省您的应用服务器

内置的API速率限制可以通过全局或每个令牌进行配置。提供智能反馈，API消费者可以使用它来在达到硬限制之前主动限制请求。

无需麻烦即可控制访问

利用Joomla强大的ACL来控制对任何附加组件、路由或请求类型的访问。专家用户可以利用Joomla的可插拔认证架构来开放企业中间件和SSO功能。

它是如何工作的？

cAPI将Slim微框架注入到Joomla应用程序实例中，允许在事件堆栈的任何级别构建服务路由插件。但这只是开始！

服务控制面板管理JSON REST API访问令牌的创建、Slim框架参数和API速率限制规则。这使得管理员可以为映射到特定Joomla用户的令牌创建，然后使用Joomla ACL将这些用户分配到具有唯一组权限的独特组。

服务路由已集成到Joomla插件中，可以单独启用/禁用或分配访问权限。这为扩展核心cAPI服务，以公开第三方Joomla扩展、数据库查询甚至远程LDAP（Microsoft Active Directory）作为RESTful JSON API打开了大门。

附加说明

安装后，请确保启用新安装的cAPI插件。将来我们将默认启用所有安装插件。另外，请确保在启用API功能之前，通过HTTPS保护您的公共网站。

变更日志

cAPI v1.3.6.1

以下版本包括一个修复，解决了由于弃用函数导致的与PHP 8+的兼容性问题。

• 实施了修复以避免getmagicquotes_gpc()函数的弃用错误。在PHP8.1中成功测试，但仍建议在PHP 7.4.x或更低版本的稳定版本上运行。
• 更新版本到1.3.6.1

cAPI v1.3.6

以下版本包括一个新用户方法，允许授权管理员返回所有用户帐户的列表。

• 创建新方法GET /user/list/all (getUserListAll)

cAPI 1.3.5.1

以下更新是一个小错误修复，解决了POST / user/edit（创建用户）方法在Swagger UI中缺少密码字段的问题。

• 增量版本到1.3.5.1
• 向postUserEdit添加密码字段
• 由于现在不需要，从services/libraries中删除capi文件夹。
• 如果没有目前使用的services/capi库，则从库列表中删除capi

cAPI v1.3.5

• 修复GET /tag/types响应以JSON解码任何编码字段。
• 添加en-GB语言定义COMSERVICESITEMDELETEDSUCCESSFULLY
• 添加token视图的en-GB语言定义
• 添加en-GB定义COMSERVICESTOKENS_ACTIONS
• 更新docblocks以参数化构建计划中的许可证、版权、作者和版本。
• 临时更新以提高与不同浏览器上CORS的兼容性，直到实现更精细的解决方案。
• 允许为dlid值留空或为null。
• 创建验证规则类JFormRuleCapidlid用于capidlid，并将函数setDlid()移动到这个验证规则中。这允许在保存和保存 & 关闭时更新dlid，并确保只保存经过验证的输入。
• 解决阻止cAPI下载ID正确分配给扩展更新站点的bug。* 删除专用的capi/dlid库和相关ARS dlid API方法，并将该功能重构为com_services管理的自定义Joomla字段。
• 删除Akeeba发布系统（ARS）API方法GET /ars/dlid
• 更新downloadid字段模式
• 从capi服务中删除dlid并添加capidlid.php自定义字段类到com_services模型。
• 解决token和tokens视图的问题，并配置管理员自定义字段token.xml
• 管理员和站点token编辑视图的token自定义字段。对于站点token编辑视图，需要Userid，以强制预先填充当前会话的Userid。
• 解决tokens列表中的状态图标问题。
• 从tokens管理视图中删除mode和debug。
• 更新com_services管理图像
• 更新语言定义。
• 删除api_throttle前端过滤器条目
• 向/administrator/com_services/models/fields/添加userid.php类
• 更新/administrator/components/com_services/views/token/tmpl/edit.php的兼容性更新
• 创建com_services管理模型字段类token.php
• 更新/administrator/components/com_services/views/token/view.html.php的兼容性更新
• 更新/administrator/components/com_services/views/tokens/tmpl/default.php的兼容性更新
• 使用可变字段更新docblocks
• 更新/administrator/components/com_services/views/tokens/view.html.php的兼容性更新
• 使用可变字段更新docblocks
• 修复controller.php docblock
• 从组件配置中删除历史记录。
• 创建自定义只读前端字段userid.php以填充tokenform。
• 创建自定义前端字段类型：令牌
• 在前端视图中移除固定的默认令牌值并使其为只读
• 包含令牌的前端视图类。
• 更新 joomla-packager.xml 防止误删除构建目录文件夹。
• 包含 com_services 组件的 installer 结构.xml。
• 对 com_services services.xml 进行兼容性更新。
• 更新 joomla-packager 以将媒体文件放在编译包的正确位置，并更新 services.xml 以包含媒体文件安装的参数。
• 将版本号增加到 1.3.5，并将版权日期更新到 2018 年。
• 解决在启用任何级别的错误报告时导致以下错误的bug："NOTICE: 尝试获取非对象属性"。
• 在 com_services 脚本.php 中包含 postflight() 函数，以在安装后自动启用与 pkg_capi_core 一起包含的服务插件。
• 撤销包清单安装脚本的工作。将功能移动到组件安装脚本中。
• 更新 joomla-packager.xml 以处理包安装脚本。
• 更新包脚本名称和清单引用到 pkgcapi_core.php。
• 包含对包脚本文件 pkg_script.php 的引用。
• 从 com_services services.xml 中移除注释掉的参数。
• 从 script.php 中移除插件安装函数。
• 撤销对语言文件文件夹定义的更改。
• 确保在构建中创建 /installer/structure.xml，但将其从原始目录 /administrator/installer/ 中移除。
• 更新以适应 structure.xml。
• 对 /components/com_services/services.php 进行兼容性更新。
• 对 /components/com_services/router.php 进行兼容性更新。
• 对 /components/com_services/controller.php 进行兼容性更新。
• 更新文档块中的版权年份。
• 对 /components/com_services/views/swaggeruimisc/view.html.php 进行兼容性更新。
• 对 /components/com_services/views/swaggerui/view.html.php 进行兼容性更新。
• 对 /components/com_services/views/slimphpframework/tmpl/default_filter.php 进行兼容性更新。
• 对 /components/com_services/views/slimphpframework/view.html.php 进行兼容性更新。
• 对前端模型字段进行兼容性更新。包括两个新字段：filemultiple.php modifiedby.php。
• 将令牌表单和过滤器 xml 文件添加到前端模型表单中。
• 对 /components/com_services/models/slimphpframework.php 进行兼容性更新。
• 添加令牌管理的客户端模型。
• 对 /components/com_services/helpers/services.php 进行兼容性更新。
• 添加令牌管理的客户端控制器。
• 对 /components/com_services/controllers/slimphpframework.php 进行兼容性更新。
• 对 /plugins/search/services/services.xml 进行兼容性更新。
• 对 /plugins/search/services/services.php 进行兼容性更新。
• 将 com_services 媒体添加到组件中。
• 在 config.xml 中更新，包括最新的字段示例的注释块。
• 对 /administrator/components/com_services/script.php 进行兼容性更新。
• 对 com_services config.xml 进行兼容性更新。
• 对 /administrator/components/com_services/controller.php 进行兼容性更新。
• 对 /administrator/components/com_services/services.php 进行兼容性更新。
• 新增管理员模型字段 modifiedby.php。
• 新增管理员模型字段 filemultiple.php。
• 对 services.css 进行兼容性更新。
• 对 /administrator/components/com_services/controllers/token.php 进行兼容性更新。
• 对 /administrator/components/com_services/controllers/tokens.php 进行兼容性更新。
• 新增 com_servers 管理员辅助类 listhelper.php。
• 对 /administrator/components/com_services/helpers/services.php 进行兼容性更新。
• 对 /administrator/components/com_services/models/fields/timeupdated.php 进行兼容性更新。
• 对 /administrator/components/com_services/models/fields/timecreated.php 进行兼容性更新。
• 对 /administrator/components/com_services/models/fields/foreignkey.php 进行兼容性更新。
• 对 /administrator/components/com_services/models/fields/custom_field.php 进行兼容性更新。
• 对 /administrator/components/com_services/models/fields/createdby.php 进行兼容性更新。
• 兼容性更新：包含 /administrator/components/com_services/models/forms/filter_tokens.xml。
• 从 token.xml 中移除令牌默认设置。
• 对 /administrator/components/com_services/models/forms/token.xml 进行兼容性更新。
• TODO：这些管理员模型类将在未来的版本中需要更新：- slimphpframework.php - swaggerui.php
• 更新 /administrator/components/com_services/models/token.php 的兼容性
• 更新 /administrator/components/com_services/models/tokens.php 的兼容性
• 新增 SQL 更新脚本：update.mysql.utf8.sql
• 移除 checkout_time 和 last_used 的默认时间。
• 更新 ServicesTabletoken 类以符合当前 Joomla 开发指南。
• 更新 GET /token/manage/all，要求拥有 general core.admin 或 com_services core.admin 权限才能列出所有令牌。重要：在服务控制面板 > 选项 > 权限中，如果管理员不希望该组拥有 com_services 的 core.admin 权限，则不应将该组赋予“配置 ACL 和选项”权限。
• 更新 updateTokenServicesRestManage() 和 deleteTokenServicesRestManage() 的安全性 - 限制为指定的 $tokenid 的 core.edit.own 权限。
• 移除阻止请求者删除用于验证方法访问的同一令牌的检查。更新权限以允许非 core.admin 用户删除自己的令牌。
• 更新 tokenServicesRestManage() 以允许当前会话中自己的令牌更新。