开发者控制台

获取和存储您的API密钥

获取和存储您的API密钥
1. 探索 - 了解您的选项 2. 选择 - 寻找解决方案 3. 适配 - 更新您的代码 4. 验证 - 测试您的应用 5. 推送 - 提交您的应用

Amazon Device Messaging (ADM)和Firebase Cloud Messaging (FCM)都要求您能够对应用进行唯一标识。使用Firebase,可以生成一个名为google-services.json的配置文件,并将其添加到应用中。使用ADM时,必须生成API密钥并将其包含在项目中。还必须生成OAuth安全配置文件凭证。

这些凭证的用途如下所示:

  • API密钥。 ADM使用API密钥验证您应用的身份。
  • OAuth凭证(“客户端ID”和“客户端密钥”)。 ADM使用OAuth凭证来验证您服务器的身份。您的服务器将提供这些凭证,以获取使用ADM发送消息的访问令牌。

以下说明提供了关于如何获取凭证的详细信息。

获取您的API密钥和凭证

  1. 开发者控制台中创建一个账户,然后添加您的应用(如果尚未执行这些操作)。

  2. 前往应用与服务 > 我的应用程序,然后选择要对其使用ADM的应用。

  3. 在边栏中,单击应用服务

  4. 亚马逊设备消息发送部分,单击选择现有安全配置文件或新建。(如果您已经为应用分配了安全配置文件,请展开附加安全配置文件和相关详细信息部分,然后继续执行步骤7。)

  5. 要为应用分配安全配置文件,请从安全配置文件下拉菜单中选择现有安全配置文件,或单击创建安全配置文件以创建新的配置文件。安全配置文件提供通过ADM发送消息时您所使用的OAuth凭证。

  6. 选择现有安全配置文件后,单击启用安全配置文件以保存更改。

    此时将显示一条成功消息,提示“使用‘安全配置文件名称’安全配置文件在您的应用上成功启用了设备消息传递”。

  7. 单击查看安全配置文件链接。然后在安全配置文件管理下,单击安卓/Kindle设置

  8. 单击添加API密钥按钮以创建API密钥。您的应用需要一个或多个API密钥。

    • 调试应用签名: 在所有情况下,必须为应用的调试版本创建一个API密钥,以便测试应用使用ADM的情况。

    • 发布版本应用签名: 如果应用使用Appstore SDK,则必须为应用的发布版本创建额外的API密钥。如果使用较旧的IAP SDK v2.0,并使用自己的证书为应用签名,您还必须为应用的发布版本创建API密钥。反之,如果使用IAP SDK v2.0,或者完全不使用应用内购买SDK,并且允许亚马逊代表您为应用签名,则无需创建额外的API密钥。如需查看摘要,请参阅下表:

      确定是否需要为发布版本应用创建API密钥。
      使用Appstore SDK的应用 用您自己的证书签名的应用 需要API秘钥?
       
       
         

    要创建API密钥,必须提供API密钥的名称、应用的程序包名称(例如com.mycompany.bestapplication),以及应用签名的MD5和SHA-256值:

    • 调试应用签名(用于应用的预发布版本): 可以通过执行以下操作之一,获取用于为应用的调试版本签名的证书的MD5或SHA-256签名:

      • 找到用于对应用进行签名的密钥库文件,以及密钥库文件中用于签名的证书的别名。例如,如果密钥库文件名为my_key_store,而密钥库中用于签名的证书名为my_certificate_alias,则应运行以下命令:

        {JAVA_HOME}/bin/keytool -list -v -alias my_certificate_alias -keystore my_keystore_file
        

        输出应包含类似如下的MD5或SHA-256值。这便是您的应用签名。

        MD5: 2E:0B:46:F8:D0:4A:06:AC:18:7A:2E:B0:42:95:58:FE`
        
        SHA-256: 34:A3:65:30:3E:B2:9B:30:DD:10:E8:87:79:16:DF:4C:61:77:BC:1F:80:BD:3F:12:39:A3:31:E6:68:19:1C:6F
        
      • 或者,如果您的应用采用的是已签名APK形式,而您正在类似Unix的系统上进行开发,则可以改为运行以下命令。请注意,必须将{your-app.apk}替换为APK文件的名称。

        MD5:

        unzip -p {your-app.apk} META-INF/CERT.RSA | keytool -printcert | grep MD5
        

        SHA-256:

        unzip -p {your-app.apk} META-INF/CERT.RSA | keytool -printcert | grep SHA-256
        
      • 或者,如果您使用的是Android Studio,请单击右侧的Gradle侧窗格并展开。然后展开app(应用)> Tasks(任务)> android,并双击signingReport(签名报告)

        提供返回的MD5和SHA-256输出。

    • 发布应用签名(适用于生产版本的应用):

      • 如果使用自己的证书为应用的发布版本签名,请提供该证书的MD5和SHA-256签名以创建额外的API密钥。
      • 如果不使用自己的证书,要获得MD5和SHA-256签名,请执行以下操作:
        1. 转到开发者控制台。
        2. 选择应用与服务>我的应用程序
        3. 选择您的应用。
        4. 转到上传您的应用文件屏幕。
        5. 选择应用商店证书哈希值
      • 您可能不需要API密钥,有关详细信息,请参阅确定是否需要为发布版本应用创建API密钥中的表格。
  9. 单击添加

  10. 获取客户端凭证(调用ADM服务器时需要)。在“安全配置文件管理”下,单击Web设置选项卡。在此页面可找到客户端ID客户端密钥

存储您的API密钥

对于应用的预发布或“调试”版本,必须创建API密钥并将其存储在项目中。要在您的应用中添加API密钥:

  1. 在项目的assets文件夹内创建一个名为api_key.txt的文件。必须将该文件放置在此特定目录中。
  2. 插入API密钥作为此api_key.txt文件中的唯一数据。

对于应用的发布或“生产”版本,如果应用使用Appstore SDK,则必须为应用的发布版本创建额外的API密钥。如果使用较旧的IAP SDK v2.0,并使用自己的证书为应用签名,您还必须为应用的发布版本创建API密钥。反之,如果使用IAP SDK v2.0,或者完全不使用应用内购买SDK,并且允许亚马逊代表您为应用签名,则无需创建额外的API密钥。若需摘要,请参阅确定是否需要为发布应用创建API密钥中的表格。

后续步骤

转到下一步: 注册和消息处理.


Last updated: 2023年10月2日