Archive:OpenSUSE:Connect API

Connect 已于 2021 年关闭。

openSUSE Connect

关于 - 安装 - API

openSUSE Connect 提供了许多其他 Web 应用程序 REST API，用于与世界其他地方进行通信。您可以在这里找到有关该 API 的详细信息，以及一些关于修改它的基本介绍。

访问 API

要访问 API，您必须选择希望结果的格式。可能的值是

• php
• json
• xml

然后，显然，您需要选择方法和参数，并且可能需要一些凭据。然后，您可以使用 GET 或 POST 访问以下 URL 上的方法

http://connect.opensuse.org/services/api/rest/${format}/?method=${method}&api_key=${key}

将 ${format}、${method} 和 ${key} 替换为正确的值。

当前可用 API

可在 connect.o.o 上找到 可用 API 命令 的列表

注意：由于整个 openSUSE Connect 仍在进行中，因此这不是最终的 API，它随时可能更改，所以不要过于依赖它 ;-)

注意：访问规则可能会根据您的身份验证应用于您的请求。

system.api.list (GET)

不接受任何参数，并返回支持的所有方法及其参数的列表。

connect.user.groups.get (GET)

接受一个参数 login - 用户的用户名。它将返回用户所属的组的列表以及这些组的一些基本属性。

connect.user.groups.add (POST)

接受两个参数 login（用户的用户名）和 group_guid（组 ID）。它将添加用户到该组，无需询问，覆盖组可能具有的所有限制。

connect.user.groups.requestjoin (POST)

接受两个参数 login（用户的用户名）和 group_guid（组 ID）。它将创建加入指定组的请求。

connect.user.create (POST)

根据参数创建新用户。必需的参数是 login、email 和 password。您可以选择指定 name。如果您还将 validate 设置为 false，则无需验证提供的电子邮件即可激活用户。

connect.user.attribute.get (GET)

接受两个参数 login 和 attribute。第一个是必需的，第二个是可选的。与之前一样，login 是用户名。可选的 attribute 参数可以指定您感兴趣的用户属性。如果未提供 attribute 或如果 attribute 是 *，则此方法将返回所有关联的元数据（它将不会返回所有用户属性，而只是可选的配置文件元数据）。

connect.entity.attribute.get (GET)

与前一个方法类似，唯一的区别是它使用 guid 作为参数，并且如果您知道您在询问什么，则可以访问任何对象。

接受两个参数 guid 和 attribute。第一个是必需的，第二个是可选的。guid 是唯一的内部实体标识符。可选的 attribute 参数可以指定您感兴趣的实体的属性。如果未提供 attribute 或如果 attribute 是 *，则此方法将返回所有关联的元数据（它将不会返回所有实体属性，而只是可选的元数据）。

connect.user.attribute.set (POST)

接受三个参数 login、attribute 和 value。所有这些都是必需的。login 是用户名。attribute 参数可以指定您感兴趣的用户属性，而 value 是您想要设置的值。

connect.entity.attribute.set (POST)

与前一个方法类似，唯一的区别是它使用 guid 作为参数，并且如果您知道您在询问什么，则可以访问任何对象。

接受三个参数 guid、attribute 和 value。所有这些都是必需的。guid 是内部对象 ID。attribute 参数可以指定您感兴趣的对象的属性，而 value 是您想要设置的值。

connect.whoami

此方法只需要您为应用程序收到的公钥。它将返回在 connect 中记录的密钥的描述。

修改 API

我们的整个 API 都实现在一个名为connect_api的插件中。请查看源代码以获取详细信息（已记录），并参阅 Elgg 关于 REST API 的文档 以获取更多信息。