WebDocumentationInvalidHeaderErrorMessage |
标头“{0}”无效 |
WebDocumentationInvalidRequestErrorMessage |
请求 URL 无效 |
TextboxLabelAccessToken |
访问令牌 * |
DropdownOptionPrimaryKeyFormat |
Primary-{0} |
DropdownOptionSecondaryKeyFormat |
Secondary-{0} |
WebDocumentationSubscriptionKeyText |
订阅密钥 |
WebDocumentationTemplatesAddHeaders |
添加必需的 HTTP 标头 |
WebDocumentationTemplatesBasicAuthSample |
基本授权示例 |
WebDocumentationTemplatesCurlForBasicAuth |
适用于基本授权: --user {username}:{password} |
WebDocumentationTemplatesCurlValuesForPath |
指定路径参数的值(显示为 {...})、订阅密钥以及查询参数的值 |
WebDocumentationTemplatesDeveloperKey |
指定订阅密钥 |
WebDocumentationTemplatesJavaApache |
此示例使用 HTTP 组件中的 Apache HTTP 客户端 (http://hc.apache.org/httpcomponents-client-ga/) |
WebDocumentationTemplatesOptionalParams |
根据需要指定可选参数的值 |
WebDocumentationTemplatesPhpPackage |
此示例使用 HTTP_Request2 包。 (有关详细信息,请参阅:https://pear.php.net/package/HTTP_Request2) |
WebDocumentationTemplatesPythonValuesForPath |
根据需要指定路径参数的值(显示为 {...})和请求正文 |
WebDocumentationTemplatesRequestBody |
指定请求正文 |
WebDocumentationTemplatesRequiredParams |
指定以下必需参数的值 |
WebDocumentationTemplatesValuesForPath |
指定路径参数的值(显示为 {...}) |
OAuth2AuthorizationEndpointDescription |
授权终结点用于与资源所有者交互以及获取授权。 |
OAuth2AuthorizationEndpointName |
授权终结点 |
OAuth2TokenEndpointDescription |
客户端可以通过提供其授权或刷新令牌,使用令牌终结点获取访问令牌。 |
OAuth2TokenEndpointName |
令牌终结点 |
OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_Description |
<p> 客户端可以将资源所有者的用户代理定向到授权终结点,从而启动流。 客户端包括客户端标识符、请求的范围、本地状态和重定向 URI。在授予(或拒绝)访问权限以后,即可通过授权服务器将用户代理发送回该 URI。 </p><p> 授权服务器会对资源所有者进行身份验证(通过用户代理),并确定资源所有者是允许还是拒绝了客户端的访问请求。 </p><p> 假定资源所有者授予了访问权限,授权服务器会使用先前在请求中或客户端注册过程中提供的重定向 URI,将用户代理重定向回客户端。 重定向 URI 包括授权代码以及客户端先前提供的任何本地状态。 </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_ErrorDescription |
<p> 如果用户拒绝了访问请求或者请求无效,则会使用下述添加到重定向的参数通知客户端: </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_Name |
授权请求 |
OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_RequestDescription |
<p> 若要启动 OAuth 过程,客户端应用必须将用户发送到授权终结点。 在授权终结点,用户会进行身份验证,并授予或拒绝对应用的访问权限。 </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_AuthorizationRequest_ResponseDescription |
<p> 假定资源所有者授予了访问权限,授权服务器会使用先前在请求中或客户端注册过程中提供的重定向 URI,将用户代理重定向回客户端。 重定向 URI 包括授权代码以及客户端先前提供的任何本地状态。 </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_Description |
<p> 客户端会包括上一步收到的授权代码,从授权服务器的令牌终结点请求访问令牌。 在发出请求时,客户端会通过授权服务器进行身份验证。 客户端会包括重定向 URI,用于获取进行验证的授权代码。 </p><p> 授权服务器会对客户端进行身份验证,对授权代码进行验证,确保收到的重定向 URI 匹配用于在步骤(C)中重定向客户端的 URI。 如果验证有效,授权服务器会使用访问令牌进行响应,以及选择性地使用刷新令牌进行响应。 </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_ErrorDescription |
<p> 如果请求客户端身份验证失败或无效,授权服务器会使用“HTTP 400 (请求错误)”状态代码进行响应(除非另有指定),并在响应中包括以下参数。 </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_RequestDescription |
<p> 客户端向令牌终结点发出请求,方法是: 以 "application/x-www-form-urlencoded" 格式发送以下参数,在 HTTP 请求实体正文中采用 UTF-8 字符编码。 </p> |
OAuth2Flow_AuthorizationCodeGrant_Step_TokenRequest_ResponseDescription |
<p> 授权服务器颁发访问令牌和可选的刷新令牌,并构造响应,方法是将以下参数添加到 HTTP 响应的实体正文,使用的状态代码为“200 (正常)”。 </p> |
OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_Description |
<p> 客户端通过授权服务器进行身份验证,并从令牌终结点请求访问令牌。 </p><p> 授权服务器对客户端进行身份验证,并在验证有效的情况下颁发访问令牌。 </p> |
OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_ErrorDescription |
<p> 如果请求的客户端身份验证失败或无效,授权服务器会使用“HTTP 400 (请求错误)”状态代码进行响应(除非另有指定),并会在响应中包括以下参数。 </p> |
OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_RequestDescription |
<p> 客户端向令牌终结点发出请求,方法是: 以 "application/x-www-form-urlencoded" 格式添加以下参数,在 HTTP 请求实体正文中采用 UTF-8 字符编码。 </p> |
OAuth2Flow_ClientCredentialsGrant_Step_TokenRequest_ResponseDescription |
<p> 如果访问令牌请求有效且获得授权,则授权服务器会颁发访问令牌和可选的刷新令牌,并构造响应,方法是将以下参数添加到 HTTP 响应的实体正文,使用的状态代码为“200 (正常)”。 </p> |
OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_Description |
<p> 客户端可以将资源所有者的用户代理定向到授权终结点,从而启动流。 客户端包括客户端标识符、请求的范围、本地状态和重定向 URI。在授予(或拒绝)访问权限以后,即可通过授权服务器将用户代理发送回该 URI。 </p><p> 授权服务器会对资源所有者进行身份验证(通过用户代理),并确定资源所有者是允许还是拒绝了客户端的访问请求。 </p><p> 假定资源所有者授予了访问权限,授权服务器会使用先前提供的重定向 URI,将用户代理重定向回客户端。 重定向 URI 在 URI 片段中包括访问令牌。 </p> |
OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_ErrorDescription |
<p> 如果资源所有者拒绝了访问请求,或者请求失败,而原因并非重定向 URI 缺失或无效,则授权服务器会通知客户端,方法是: 使用 "application/x-www-form-urlencoded" 格式将以下参数添加到重定向 URI 的片段组件。 </p> |
OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_RequestDescription |
<p> 若要启动 OAuth 过程,客户端应用必须将用户发送到授权终结点。 在授权终结点,用户会进行身份验证,并授予或拒绝对应用的访问权限。 </p> |
OAuth2Flow_ImplicitGrant_Step_AuthorizationRequest_ResponseDescription |
<p> 如果资源所有者允许了访问请求,则授权服务器会颁发访问令牌并将其提供给客户端,方法是: 使用 "application/x-www-form-urlencoded" 格式将以下参数添加到重定向 URI 的片段组件。 </p> |
OAuth2Flow_ObtainAuthorization_AuthorizationCodeGrant_Description |
对于能够保持其凭据机密性的客户端(例如,使用 PHP、Java、Python、Ruby、ASP.NET 等实现的 Web 服务器应用程序),将对授权代码流进行优化。 |
OAuth2Flow_ObtainAuthorization_AuthorizationCodeGrant_Name |
授权代码授予 |
OAuth2Flow_ObtainAuthorization_ClientCredentialsGrant_Description |
客户端凭据流适用于客户端(应用程序)请求访问其所控制的受保护资源的情况。 可以将客户端视为资源所有者,因此不需要最终用户交互。 |
OAuth2Flow_ObtainAuthorization_ClientCredentialsGrant_Name |
客户端凭据授予 |
OAuth2Flow_ObtainAuthorization_ImplicitGrant_Description |
对于无法保持其凭据(已知会操作特定的重定向 URI)机密性的客户端,将对隐式流进行优化。 通常会在浏览器中使用脚本语言(例如 JavaScript)实现这些客户端。 |
OAuth2Flow_ObtainAuthorization_ImplicitGrant_Name |
隐式授权 |
OAuth2Flow_ObtainAuthorization_ResourceOwnerPasswordCredentialsGrant_Description |
资源所有者密码凭据流适用于资源所有者与客户端(应用程序)存在信任关系的情况,例如,设备操作系统或具有很高特权的应用程序均可充当客户端。 此流适用于能够获取资源所有者凭据(用户名和密码,通常使用交互形式)的客户端。 |
OAuth2Flow_ObtainAuthorization_ResourceOwnerPasswordCredentialsGrant_Name |
资源所有者密码凭据授予 |
OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_Description |
<p> 资源所有者为客户端提供用户名和密码。 </p><p> 客户端会包括从资源所有者处收到的凭据,从授权服务器的令牌终结点请求访问令牌。 在发出请求时,客户端会通过授权服务器进行身份验证。 </p><p> 授权服务器对客户端进行身份验证,同时验证资源所有者的凭据,并在验证有效的情况下颁发访问令牌。 </p> |
OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_ErrorDescription |
<p> 如果请求的客户端身份验证失败或无效,授权服务器会使用“HTTP 400 (请求错误)”状态代码进行响应(除非另有指定),并会在响应中包括以下参数。 </p> |
OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_RequestDescription |
<p> 客户端向令牌终结点发出请求,方法是: 以 "application/x-www-form-urlencoded" 格式添加以下参数,在 HTTP 请求实体正文中采用 UTF-8 字符编码。 </p> |
OAuth2Flow_ResourceOwnerPasswordCredentialsGrant_Step_TokenRequest_ResponseDescription |
<p> 如果访问令牌请求有效且获得授权,则授权服务器会颁发访问令牌和可选的刷新令牌,并构造响应,方法是将以下参数添加到 HTTP 响应的实体正文,使用的状态代码为“200 (正常)”。 </p> |
OAuth2Step_AccessTokenRequest_Name |
访问令牌请求 |
OAuth2Step_AuthorizationRequest_Name |
授权请求 |
OAuth2AccessToken_AuthorizationCodeGrant_TokenResponse |
必需。 由授权服务器颁发的访问令牌。 |
OAuth2AccessToken_ClientCredentialsGrant_TokenResponse |
必需。 由授权服务器颁发的访问令牌。 |
OAuth2AccessToken_ImplicitGrant_AuthorizationResponse |
必需。 由授权服务器颁发的访问令牌。 |
OAuth2AccessToken_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
必需。 由授权服务器颁发的访问令牌。 |
OAuth2ClientId_AuthorizationCodeGrant_AuthorizationRequest |
必需。 客户端标识符。 |
OAuth2ClientId_AuthorizationCodeGrant_TokenRequest |
如果客户端不使用授权服务器进行身份验证,则此项为必需。 |
OAuth2ClientId_ImplicitGrant_AuthorizationRequest |
必需。 客户端标识符。 |
OAuth2Code_AuthorizationCodeGrant_AuthorizationResponse |
必需。 授权服务器生成的授权代码。 |
OAuth2Code_AuthorizationCodeGrant_TokenRequest |
必需。 从授权服务器接收的授权代码。 |
OAuth2ErrorDescription_AuthorizationCodeGrant_AuthorizationErrorResponse |
可选。 提供附加信息的用户可读 ASCII 文本。 |
OAuth2ErrorDescription_AuthorizationCodeGrant_TokenErrorResponse |
可选。 提供附加信息的用户可读 ASCII 文本。 |
OAuth2ErrorDescription_ClientCredentialsGrant_TokenErrorResponse |
可选。 提供附加信息的用户可读 ASCII 文本。 |
OAuth2ErrorDescription_ImplicitGrant_AuthorizationErrorResponse |
可选。 提供附加信息的用户可读 ASCII 文本。 |
OAuth2ErrorDescription_ResourceOwnerPasswordCredentialsGrant_TokenErrorResponse |
可选。 提供附加信息的用户可读 ASCII 文本。 |
OAuth2ErrorUri_AuthorizationCodeGrant_AuthorizationErrorResponse |
可选。 一个 URI,用于标识提供有关此错误的信息的用户可读网页。 |
OAuth2ErrorUri_AuthorizationCodeGrant_TokenErrorResponse |
可选。 一个 URI,用于标识提供有关此错误的信息的用户可读网页。 |
OAuth2ErrorUri_ClientCredentialsGrant_TokenErrorResponse |
可选。 一个 URI,用于标识提供有关此错误的信息的用户可读网页。 |
OAuth2ErrorUri_ImplicitGrant_AuthorizationErrorResponse |
可选。 一个 URI,用于标识提供有关此错误的信息的用户可读网页。 |
OAuth2ErrorUri_ResourceOwnerPasswordCredentialsGrant_TokenErrorResponse |
可选。 一个 URI,用于标识提供有关此错误的信息的用户可读网页。 |
OAuth2Error_AuthorizationCodeGrant_AuthorizationErrorResponse |
必需。 下述某个 ASCII 错误代码: invalid_request、unauthorized_client、access_denied、unsupported_response_type、invalid_scope、server_error、temporarily_unavailable。 |
OAuth2Error_AuthorizationCodeGrant_TokenErrorResponse |
必需。 下述某个 ASCII 错误代码: invalid_request、invalid_client、invalid_grant、unauthorized_client、unsupported_grant_type、invalid_scope。 |
OAuth2Error_ClientCredentialsGrant_TokenErrorResponse |
必需。 下述某个 ASCII 错误代码: invalid_request、invalid_client、invalid_grant、unauthorized_client、unsupported_grant_type、invalid_scope。 |
OAuth2Error_ImplicitGrant_AuthorizationErrorResponse |
必需。 下述某个 ASCII 错误代码: invalid_request、unauthorized_client、access_denied、unsupported_response_type、invalid_scope、server_error、temporarily_unavailable。 |
OAuth2Error_ResourceOwnerPasswordCredentialsGrant_TokenErrorResponse |
必需。 下述某个 ASCII 错误代码: invalid_request、invalid_client、invalid_grant、unauthorized_client、unsupported_grant_type、invalid_scope。 |
OAuth2ExpiresIn_AuthorizationCodeGrant_TokenResponse |
推荐。 访问令牌的生存期,以秒为单位。 |
OAuth2ExpiresIn_ClientCredentialsGrant_TokenResponse |
推荐。 访问令牌的生存期,以秒为单位。 |
OAuth2ExpiresIn_ImplicitGrant_AuthorizationResponse |
推荐。 访问令牌的生存期,以秒为单位。 |
OAuth2ExpiresIn_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
推荐。 访问令牌的生存期,以秒为单位。 |
OAuth2GrantType_AuthorizationCodeGrant_TokenRequest |
必需。 必须将值设置为 "authorization_code"。 |
OAuth2GrantType_ClientCredentialsGrant_TokenRequest |
必需。 必须将值设置为 "client_credentials"。 |
OAuth2GrantType_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
必需。 必须将值设置为 "password"。 |
OAuth2Password_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
必需。 资源所有者密码。 |
OAuth2RedirectUri_AuthorizationCodeGrant_AuthorizationRequest |
可选。 重定向终结点 URI 必须是绝对 URI。 |
OAuth2RedirectUri_AuthorizationCodeGrant_TokenRequest |
如果 "redirect_uri" 参数已包括在授权请求中且其值必须相同,则此项为必需。 |
OAuth2RedirectUri_ImplicitGrant_AuthorizationRequest |
可选。 重定向终结点 URI 必须是绝对 URI。 |
OAuth2RefreshToken_AuthorizationCodeGrant_TokenResponse |
可选。 刷新令牌,可用于获取新的访问令牌。 |
OAuth2RefreshToken_ClientCredentialsGrant_TokenResponse |
可选。 刷新令牌,可用于获取新的访问令牌。 |
OAuth2RefreshToken_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
可选。 刷新令牌,可用于获取新的访问令牌。 |
OAuth2ResponseType_AuthorizationCodeGrant_AuthorizationRequest |
必需。 必须将值设置为 "code"。 |
OAuth2ResponseType_ImplicitGrant_AuthorizationRequest |
必需。 必须将值设置为 "token"。 |
OAuth2Scope_AuthorizationCodeGrant_AuthorizationRequest |
可选。 访问请求的范围。 |
OAuth2Scope_AuthorizationCodeGrant_TokenResponse |
如果与客户端请求的范围相同,则此项为可选;否则此项为必需。 |
OAuth2Scope_ClientCredentialsGrant_TokenRequest |
可选。 访问请求的范围。 |
OAuth2Scope_ClientCredentialsGrant_TokenResponse |
如果与客户端请求的范围相同,则此项为可选;否则此项为必需。 |
OAuth2Scope_ImplicitGrant_AuthorizationRequest |
可选。 访问请求的范围。 |
OAuth2Scope_ImplicitGrant_AuthorizationResponse |
如果与客户端请求的范围相同,则此项为可选;否则此项为必需。 |
OAuth2Scope_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
可选。 访问请求的范围。 |
OAuth2Scope_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
如果与客户端请求的范围相同,则此项为可选;否则此项为必需。 |
OAuth2State_AuthorizationCodeGrant_AuthorizationErrorResponse |
如果客户端授权请求中存在 "state" 参数,则此项为必需。 从客户端收到的确切值。 |
OAuth2State_AuthorizationCodeGrant_AuthorizationRequest |
推荐。 一个不透明值,可供客户端用来保持请求和回调之间的状态。 在将用户代理重定向回客户端时,授权服务器会包括此值。 应使用此参数防止跨站点请求伪造。 |
OAuth2State_AuthorizationCodeGrant_AuthorizationResponse |
如果客户端授权请求中存在 "state" 参数,则此项为必需。 从客户端收到的确切值。 |
OAuth2State_ImplicitGrant_AuthorizationErrorResponse |
如果客户端授权请求中存在 "state" 参数,则此项为必需。 从客户端收到的确切值。 |
OAuth2State_ImplicitGrant_AuthorizationRequest |
推荐。 一个不透明值,可供客户端用来保持请求和回调之间的状态。 在将用户代理重定向回客户端时,授权服务器会包括此值。 应使用此参数防止跨站点请求伪造。 |
OAuth2State_ImplicitGrant_AuthorizationResponse |
如果客户端授权请求中存在 "state" 参数,则此项为必需。 从客户端收到的确切值。 |
OAuth2TokenType_AuthorizationCodeGrant_TokenResponse |
必需。 已颁发令牌的类型。 |
OAuth2TokenType_ClientCredentialsGrant_TokenResponse |
必需。 已颁发令牌的类型。 |
OAuth2TokenType_ImplicitGrant_AuthorizationResponse |
必需。 已颁发令牌的类型。 |
OAuth2TokenType_ResourceOwnerPasswordCredentialsGrant_TokenResponse |
必需。 已颁发令牌的类型。 |
OAuth2UserName_ResourceOwnerPasswordCredentialsGrant_TokenRequest |
必需。 资源所有者用户名。 |
OAuth2UnsupportedTokenType |
不支持令牌类型“{0}”。 |
OAuth2InvalidState |
来自授权服务器的响应无效 |
OAuth2GrantType_AuthorizationCode |
授权代码 |
OAuth2GrantType_Implicit |
隐式 |
OAuth2GrantType_ClientCredentials |
客户端凭据 |
OAuth2GrantType_ResourceOwnerPassword |
资源所有者密码 |
WebDocumentation302Code |
302 已找到 |
WebDocumentation400Code |
400 (请求错误) |
OAuth2SendingMethod_AuthHeader |
授权标头 |
OAuth2SendingMethod_QueryParam |
查询参数 |
OAuth2AuthorizationServerGeneralException |
通过 {0} 授予访问权限时出错 |
OAuth2AuthorizationServerCommunicationException |
无法建立到授权服务器的 HTTP 连接,或者已意外关闭该连接。 |
WebDocumentationOAuth2GeneralErrorMessage |
出现了意外错误。 |
AuthorizationServerCommunicationException |
出现授权服务器通信异常。 请与管理员联系。 |
TextblockSubscriptionKeyHeaderDescription |
订阅密钥,用于访问此 API。 在<a href='/developer'>配置文件</a>中查找。 |
TextblockOAuthHeaderDescription |
从 <>{0}<> 获得的 OAuth 2.0 访问令牌。 支持的授权类型:<>{1}<>。 |
TextblockContentTypeHeaderDescription |
发送到 API 的正文的媒体类型。 |
ErrorMessageApiNotAccessible |
此时无法访问正在尝试调用的 API。 请在<>此处<>联系 API 发布者。 |
ErrorMessageApiTimedout |
正在尝试调用的 API 获得响应所花的时间超出正常。 请在<>此处<>联系 API 发布者。 |
BadRequestParameterExpected |
“应使用‘{0}’参数” |
TooltipTextDoubleClickToSelectAll |
双击全选。 |
TooltipTextHideRevealSecret |
显示/隐藏 |
ButtonLinkOpenConsole |
试用 |
SectionHeadingRequestBody |
请求正文 |
SectionHeadingRequestParameters |
请求参数 |
SectionHeadingRequestUrl |
请求 URL |
SectionHeadingResponse |
响应 |
SectionHeadingRequestHeaders |
请求标头 |
FormLabelSubtextOptional |
可选 |
SectionHeadingCodeSamples |
代码示例 |
TextblockOpenidConnectHeaderDescription |
从 <>{0}<> 获得的 OpenID Connect ID 令牌。 支持的授权类型:<>{1}<>。 |