大多数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令牌的示例用法: