fetchtoken.
fetchtoken. 获取用户令牌,这是代表Bonanza用户制作安全API呼叫的基础。使用已验证的用户令牌,您可以为用户的展位添加项目,或者从尚未获得销售的摊位中获取有关项目的信息。
使用此呼叫获取用户令牌后,必须将用户发送URL,它们将用于验证您的业务是否有代表其与Bonanza互动。用户令牌 必须验证 由用户在可以使用之前。
有关用户令牌如何工作的更多信息,请参阅我们的 介绍用户令牌.
看一看 在C#,Java,PHP,Python和Ruby中的一些示例。
fetchtoken的输入
fetchtoken是一种安全的API方法,具有以下URL和HTTP标头要求:
提交给URL: | //api.sanyili.com/api_requests/secure_request |
HTTP标题中需要: | x-bonanzle-api-dev-name设置为dev_id |
x-bonanzle-api-cert-name设置为您的cert_id |
请注意,除此之外的所有安全方法 fetchtoken. 和 GetboothItems. 要求您提交用户令牌,以便我们知道您代表的用户帐户。 有关设置和提交用户令牌的详细信息,请参阅我们的 介绍用户令牌.
您请求的名称应该是 fetchtokenRequest..
以下是可用的输入参数 序列化为json.:
争论 | 类型 | 发生 | 意义 |
---|---|---|---|
验证符合验证 | Uri. | 选修的 | 用户成功验证令牌后,我们将为它们提供一个按钮,以便执行此URL(如果提供)。 |
注册表 | 容器 | 选修的 | 注册数据,适用于重新注册的用户。 |
注册表。名 | 细绳 | 选修的 | 用户的名字 |
注册表。姓 | 细绳 | 选修的 | 用户的姓氏 |
注册表。城市 | 细绳 | 选修的 | 市的城市 |
注册表。状态 | 细绳 | 选修的 | 州或用户省 |
注册表。国家 | 细绳 | 选修的 | 两位数国家代码 |
注册表。邮政编码 | 细绳 | 选修的 | 邮编/邮政编码 |
注册表。电子邮件 | 细绳 | 选修的 | 用户的电子邮件地址 |
fetchtoken输出
从此请求返回的输出的名称是fetchTokenResponse。因此,在将序列化响应解析为JSON之后,您可以使用类似的东西访问数据 my_json_hash ['fetchtokenresponse']
以下是所有可能的输出参数:
争论 | 类型 | 发生 | 意义 |
---|---|---|---|
标准输出字段 | |||
错误信息 | 容器 | Conditionally | 当Bonanza处理请求时发生错误或警告的描述。如果ACK值为成功,则不返回。 |
errorMessage.错误 | 容器 |
Conditionally, repeatable: [0..*] |
|
errorMessage.error.类别 | ErrorCategory | Conditionally | Currently unused. |
errorMessage.error.信息 | string | Conditionally | 错误描述 |
errorMessage.error.类型 | 纠刊 | Conditionally | 错误的唯一描述性名称。 |
警告 | 容器 | Conditionally | 当Bonanza处理请求时发生的警告说明。 |
warnings.未识别的_分数 | 容器 |
Conditionally, repeatable: [0..*] |
一个无法识别的参数数组。 |
呼叫特定的输出字段 | |||
authtoken. | 细绳 | 总是 | 令牌您将提交给Bonanza表示您希望与此用户进行互动。 |
AuthenticationUrl. | 奥里瑞 | 总是 | 您应该向用户发送用户,以验证他们是否希望授权您代表他们的行为。用户将以登录屏幕呈现,告诉他们他们正在授权您的业务来获取授权操作。登录后,将验证Auth Token,您可以使用用户令牌开始进行安全调用。在验证用户令牌时,您将在您与Bonapitit帐户关联的地址发送电子邮件。 |
Emailrecognized. | 布尔基 | 有条件地,如果通过电子邮件已通过 | 如果使用RegistalyData传递的电子邮件已作为活动用户存在,则为TRUE,如果没有,则为FALSE。如果电子邮件字段未在注册表中传递,则不会返回。 |
硬折杂时间 | 约会时间 | 总是 | 这个令牌到期的日期。默认情况下,您将在获取之后一年到期。用户还可以选择早期通过Bonanza帐户到期令牌。 |