身份验证

当发出任何API请求时，你必须通过以下方式之一进行身份验证:

• 通过生成个人API令牌
• 通过请求一个OAuth 2访问令牌

请使用HTTPS发送API请求。

通过普通HTTP进行的调用将失败。

API令牌验证

0. 请注意，您必须在项目中拥有管理员角色，才能使用提供的API令牌访问该项目。
1. 要生成新的API令牌，请打开localise并点击左下角的团队头像。
2. 继续配置文件设置> API令牌．
3. 点击生成新的令牌并选择要创建的令牌类型(只读或读写)。
4. 复制新创建的令牌，并将其安全存储在应用程序中(具体来说，它应该被添加到Git版本控制中)。
5. 您的令牌应该与每个API请求一起发送X-Api-Token标题:

X-Api-Token: f4d3f29bf893dc3583e9970735e08de094e82b0

• 您可以找到更多关于API令牌的信息在官方文档中．
• 您还可以在本地化API:示例应用部分。

OAuth 2身份验证

如果你的应用程序需要代表其他用户，你可以实现一个OAuth 2流：

1. 通过聊天小部件联系我们的支持团队www.wwealerts.com并要求注册一个新的OAuth 2应用程序。请提供以下信息:
   • 申请名称
   • 应用程序的Logo (150x150px, PNG或JPG)
   • 应用程序的描述(可选)。
   • 链接到应用程序网站/文档(可选)。
   • 要求的范围。找到对应API端点所需的作用域列表
2. 您将获得客户端ID和客户端机密。请记住，客户的秘密绝对不能被公开。
3. 你的应用程序应该将用户重定向到认证URLhttps://app.www.wwealerts.com/oauth2/auth．下面的GET参数必须添加到这个URL:
   • client_id
   • redirect_uri-在你的应用程序中的一个URL，用户将在授权后被发送。
   • 范围-应该包含一个你的应用程序需要访问的以空格分隔的范围列表。例如，你需要一个write_projects创建新项目的范围。您可以在每个API端点下找到所需的作用域。
   • 状态(如果不使用，可选redirect_uri) -用于防止CSRF攻击的随机字符串。
4. 一旦用户授权访问他们的帐户，他们将被重定向回你的应用程序连同一个oauth_code．你的应用程序应该发出一个POST请求https://app.www.wwealerts.com/oauth2/token与以下主体参数一起:
   • grant_type——应authorization_token
   • client_id
   • client_secret
   • 代码-发送到你的应用程序的代码
5. 发送POST请求后，您将收到一个响应access_token而且refresh_token．现在可以通过提供access_token下授权标题如下:

curl -H“授权:承载someAccessToken”https://api.www.wwealerts.com/api2/projects

6. 访问令牌通常在60分钟内过期，所以为了请求一个新的令牌，你的应用程序应该发送另一个POST请求https://app.www.wwealerts.com/oauth2/token准备如下数据:
   • grant_type——应refresh_token
   • client_id
   • client_secret
   • refresh_token

• 你可以找到关于OAuth 2流程的详细信息在官方文档中．
• 您可以在下面找到示例OAuth 2流实现本地化API:示例应用部分。