大多数 API 调用都需要经过身份验证的用户。API 不使用任何特殊的个人资料。每个 API 都可以使用其用户名和密码代表任何现有用户进行调用。
有两种方法可以对 API 进行身份验证:
-
基于令牌的身份验证
-
OAuth 2.0 身份验证
基于令牌的身份验证
在调用任何需要经过身份验证的用户的 API 之前,请调用 auth/login API 以获取身份验证令牌。令牌有效期为 24 小时,可用于所有后续调用,但如果用户通过 UI 注销,令牌将会过期。请勿为每次调用创建新令牌。
多个 TMS 公司的成员对多个账户使用相同的用户名和密码。如果使用多个账户,必须将 userUid 添加到请求正文中,以指定用户想要登录的公司。如果未指定,用户将登录到与给定用户名和密码关联的默认账户。
在后续 API 调用中,所获得的令牌将用于 Authorization 标头。标头值字段以 ApiToken 开头,后跟一个空格和令牌本身。
如果用户从 UI 注销,API 令牌将不再有效。
如果个人资料位于美国数据中心,请在 cloud.memsource.com 之前添加 us.,例如 https://us.cloud.memsource.com/web/api2/v3/auth/login.
示例:
OAuth 2.0 身份验证
在应用程序中使用 OAuth 2.0,而不是在每次调用时发送令牌。Phrase TMS 支持标准的 OAuth 2.0 authorization code grant type。
要建立 OAuth 2.0 连接,请遵循以下步骤:
-
从设置
页面,向下滚动到 部分,然后点击 Registered OAuth Apps。
页面打开。
-
单击新建。
页面打开。
-
提供 、(回调)以及可选的 。
-
点击保存。
页面打开,列表中包含新连接以及关联的 。
该 ID 用于连接到 Phrase 的应用程序中以建立连接。它存储在数据库中,并用于将请求与正确的请求者配对。
-
将这些 URL 与生成的客户 ID 一起使用以进行授权:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
如果个人资料位于美国数据中心,请在 cloud.memsource.com 之前添加 us.,例如 https://us.cloud.memsource.com/web/oauth/authorize
-
-
授权时,使用管理员个人资料登录并点击 Allow。
应用程序现已关联,无需进行身份验证 API 调用。
一旦建立 OAuth 2.0 连接,就会生成一个 Bearer 令牌供应用程序使用。
Example usage of Bearer token: