as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
AWS
文档
Support
Contact Us
My Cases
新手入门
设计和开发
应用发布
参考
支持

SimpleSignInService

SimpleSignInService

提供与亚马逊简单登录框架进行交互的主要API。第三方应用开发者调用API来协调用户登录流程,即使用与亚马逊关联的简单登录账户进行登录。

构造函数

new SimpleSignInService()

new SimpleSignInService(): SimpleSignInService

返回值

SimpleSignInService

方法

static getUserAndLinks(identityProviderName): Promise<GetUserAndLinksResponse>

发起请求,通过请求应用获取设备上当前有效亚马逊用户的简单登录相关数据。响应包括以下数据段:

  • 有效关联账户的列表,以及每个账户的新SSI令牌。
  • 您的亚马逊用户限定范围的身份,应用在令牌生成期间使用该身份将linkToken范围限定为亚马逊用户。

参数

identityProviderName

string

用于对登录您应用的用户进行身份验证的身份提供方的名称。这是您在开发者控制台上完成简单登录入门期间收到的ID。

返回值

Promise<GetUserAndLinksResponse>

一个Promise对象,解析后给出的响应包含使用亚马逊创建的user-id和现有链接。


linkUserAccount()

static linkUserAccount(request): Promise<LinkUserAccountResponse>

为用户的应用账户启动账户关联。该解决方案允许在亚马逊和应用账户之间进行N:N映射。可以有多个应用账户与一个亚马逊账户关联,一个应用账户可以同时关联多个亚马逊账户。

在设置账户关联之前,简单登录客户端会显示用户同意屏幕,提示用户予以同意。在获得用户同意后,关联数据和linkToken一起存储在简单登录服务器上。如果用户拒绝同意账户关联,则关联过程将中止,并丢弃从您收到的linkToken。

参数

request

LinkUserAccountRequest

请求包含合作伙伴用户ID、身份提供方名称、用户登录名、第三方应用生成的链接令牌以及第三方应用生成的链接签名密钥。

返回值

Promise<LinkUserAccountResponse>

一个Promise对象,解析后给出的响应包含所创建链接的link-id和链接创建请求的success-code。


recordMetricEvent()

static recordMetricEvent(request): Promise<RecordMetricsEventResponse>

启动一个需要记录才能发布指标的事件。可以在开发者控制台的“报告”选项卡中下载简单登录业务指标报表。利用这些指标,可以深入了解与SSI集成的业务价值和影响。

参数

request

SSIEventRequest

请求包含SSI事件、以毫秒为单位的时间戳和失败原因(如果SSI事件失败)。

返回值

Promise<RecordMetricsEventResponse>

一个Promise对象,解析后会返回请求成功或失败的状态。


showLoginSelection()

static showLoginSelection(loginNames): Promise<ShowLoginSelectionResponse>

启动屏幕以向用户显示登录选项。在启动此API之前,对于使用getUserAndLinks API提取的每个关联账户,应用应该从应用服务器检索一个友好的用户可识别的标识符(如登录名/电子邮件地址/个人资料名称),并将此数据包含在请求中。此数据显示在屏幕上,用于帮助客户轻松识别关联的应用账户。

参数

loginNames

LoginNameValue[]

要显示的登录名列表及其link-id映射。

返回值

Promise<ShowLoginSelectionResponse>

一个Promise对象,解析后会返回用户的选择;如果用户选择使用该对象登录,则提供相应的link-id。


Last updated: 2025年10月2日