Verify 应用程序接口（API）

在线编辑

Verify 应用程序接口（API）可供访问并用于内部应用程序开发。

支持 如需了解更多信息，请参阅 “ IBM® Verify 文档中心 ”中的 API 文档。

IBM 培训 在 IBM 培训中观看一个 Verify API视频。

HTTP 方法

每个 API 资源都由一个指定的统一资源标识 (URI) 进行标识，并通过使用以下标准 HTTP 方法进行访问。 HTTP 方法指示针对对象的目标操作。
表 1. HTTP 方法
HTTP 方法 描述
GET 在指定的 URL 检索资源或关系。
  • 在资源 URL 级别 (<resource-noun>) 发起请求，将检索所有实例，同时受搜索和分页限制的约束（参见“搜索”部分）。
  • 在资源 ID 级别发起的请求 (<resource-noun>/<resource-id>) 将返回单个资源。
  • 在关系名称级别 (<relationship>) 执行的查询将检索所有关系实例，并受搜索和分页限制的约束。
  • 缺省响应状态码为 200。
  • 结果的分页可以通过添加查询参数（如“count”，最大值为 1000）进行定制。
  • 在关系 ID 级别发起的请求 (<relationship>/<relationship-id>) 将返回一个单独的关系实例。
POST 在指定 URL 处创建资源或关系。
  • 对资源 URL 发起的请求（<resource-noun>）将创建该资源。
  • 在关系 ID 级别发送请求 (<relationship>) 将创建新的关系。
  • 可用于批量装入创建。
PUT 在指定 URL 处更新资源或关系。
  • 对资源 URL 发起的请求（<resource-noun>）将更新该资源。
  • 在关系 ID 级别发起的请求 (<relationship>) 会更新新关系。 并非所有关系都可以修改，因此在某些情况下，此请求可能会被视为错误请求。
  • 更改只读信息（例如，资源或关系标识）的请求被视为错误请求。
PATCH

用于对资源执行部分更新。

  • 在资源类型 URL 级别发起的请求（<resource-noun> 仅更新请求中指定的资源属性所对应的变更部分）。
  • PATCH 的内容类型为 application/json-patch+json。
  • 如果使用主要标识（映射到主键的唯一标识或特性）指定删除操作，那么会删除整个对象。
删除 在指定 URL 处除去资源或关系。
注意： 若要批量删除，请使用 PATCH 方法。