跳转至

API 根 URL

所有 API 集均具有以下 URL 格式:

<api-root>/``<domain>``/``<version>``/``...(API-specific suffix)

  • <api-root> 所有 REST API 的根端点,取决于 CCH Tagetik 的部署类型(本地部署或云),在云服务的情况下,还取决于所选择的身份验证模式。请参阅以下段落
  • <domain> API 集的名称或功能(例如 aihaudit、...)
  • <version> API 集的当前版本 (v1v2...)。随着 API 集新版本的发布,旧版本可能会被弃用,并在后续版本中停用。版本为 v0 的集被视为实验性,可能会在新版本中停用,恕不另行通知,且无弃用期。

本地部署环境

<api-root> 具有以下格式

<application url>/api/

其中:

  • <application url> 是用于访问 Web 应用程序的同一 URL

示例:

https://mydomain/tagetikcpm/api/scim/v2/Users

云环境

在 Tagetik Cloud 的某些区域,提供了新的 API 访问服务,支持多种身份验证策略。有关启用此服务的区域信息,请查阅发行说明。

在这些情况下,<api-root> 具有以下格式

<tenant>.api.saastagetik.com/<authentication strategy>/

其中:

  • <tenant> 是当前租户的名称(例如 abcprod
  • <authentication strategy strategy>oauth2basicapi-keyjwt 之一,取决于所使用的身份验证策略。有关更多信息,请参阅身份验证 - 云" 一节。
  • <domain> API 集的名称或功能(例如 aihaudit、...)

示例:

https://mytenantprod.api.saastagetik.com/oauth2/scim/v2/Users