大多数 API 调用都需要经过身份验证的用户。API 不使用任何特殊的用户配置文件。每个 API 都可以代表任何现有用户使用其用户名和密码调用。
API 身份验证有两种方法:
-
基于令牌身份验证
-
OAuth 2.0 身份验证
基于令牌的身份验证
在调用任何需要身份验证用户的 API 之前,调用身份验证/登录 API 以获得身份验证令牌。令牌有效期为 24 小时,可用于后续所有调用,但如果用户通过用户界面注销,令牌将过期。不要为每个调用创建一个令牌。
多个 TMS 组织的成员为多个帐户具有相同的用户名和密码。如果使用多个帐户,则必须在请求正文中添加 userUid
,以指定该用户要登录的公司。如果未指定,用户登录到与给定用户名和密码关联的默认账户。
在随后的 API 调用中,获得的令牌用于授权
标头。标头值字段以 ApiToken
开头,后跟空间和令牌本身。
如果用户从用户界面注销,API 令牌将不再有效。
如果个人资料位于美国数据中心,在 cloud.memsource.com 之前添加我们。例如 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 之前添加我们。例如 https://us.cloud.memsource.com/web/oauth/authorize
-
-
授权时,使用管理员个人资料登录并单击允许。
应用程序现已关联,不需要身份验证 API 调用。
OAuth 2.0 连接建立后,将生成一个承载令牌供应用程序使用。
不记名令牌使用示例: