大多数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 授权代码授权类型。
要建立 OAuth 2.0 连接,请按照以下步骤操作:
-
从设置
页面,向下滚动到 部分并点击 注册的 OAuth 应用。
页面打开。
-
单击新建。
页面打开。
-
提供一个
, (回调)和一个可选的 。 -
点击保存。
页面打开,列表中有新的连接和相关的 。
该 ID 用于连接到 Phrase 的应用程序以建立连接。它存储在数据库中,用于将请求与正确的请求者配对。
-
使用这些 URL 和生成的客户端 ID 进行授权:
-
授权 URL
https://cloud.memsource.com/web/oauth/authorize
-
令牌 URL
https://cloud.memsource.com/web/oauth/token
如果配置文件位于美国数据中心,请在 cloud.memsource.com 之前添加 us.,例如 https://us.cloud.memsource.com/web/oauth/authorize
-
-
授权时,请使用管理员配置文件登录并点击 允许。
应用程序现在已链接,身份验证 API 调用将不再需要。
一旦建立 OAuth 2.0 连接,将生成一个 Bearer 令牌以供应用程序使用。
Bearer 令牌的示例用法: