如何获取身份云API开放平台访问密钥分步指南

在当今的数字化时代，无论是数字媒体的创新、软件开发的深入，还是日常生活的便捷性提升，身份认证与数据管理都扮演着至关重要的角色。身份云API开放平台正是为此而生，它提供了强大的身份验证与数据管理解决方案，使开发者能够高效、安全地集成身份认证功能于各类应用之中。本文将详细指导你如何获取身份云API开放平台的访问密钥，这是实现上述功能的第一步，也是确保应用安全与用户体验的关键所在。接下来，我们还将概述如何进行初步的接入测试，并探讨在实际应用中可能遇到的重要考量因素，帮助你更好地利用身份云API的力量。

1. 登录/注册身份云API开放平台

2. 创建应用

1. 如图创建B2E用户池

2.自建应用–》创建自建应用

3. 获取密钥

1.进入自建应用菜单进入刚刚创建的应用

2.复制密钥

4. 使用密钥

方法一：安装 Authing library

首先，通过 npm / yarn 安装 Authing library。

# 兼容 Vue 2

npm install --save @authing/guard-vue2



# OR



yarn add @authing/guard-vue2

// 代码示例：https://github.com/Authing/Guard/blob/v5/examples/guard-vue2/normal/src/main.js

// main.js

import Vue from "vue";

import { GuardPlugin } from "@authing/guard-vue2";

import "@authing/guard-vue2/dist/esm/guard.min.css";



Vue.use(GuardPlugin, {

  appId: "AUTHING_APP_ID",



  // 如果你使用的是私有化部署的 Authing 服务，需要传入自定义 host，如:

  // host: 'https://my-authing-app.example.com',



  // 默认情况下，会使用你在 Authing 控制台中配置的第一个回调地址为此次认证使用的回调地址。

  // 如果你配置了多个回调地址，也可以手动指定（此地址也需要加入到应用的「登录回调 URL」中）：

  // redirectUri: "YOUR_REDIRECT_URI"

});

调试成功后，即完成 Authing library 的初始化加载。

方法二：直接通过浏览器加载

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="UTF-8" />

    <meta http-equiv="X-UA-Compatible" content="IE=edge" />

    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>Authing Guard Demo</title>

    <script src="https://cdn.authing.co/packages/guard/5.1.5/guard.min.js"></script>

    <link rel="stylesheet" href="https://cdn.authing.co/packages/guard/5.1.5/guard.min.css" />

  </head>

  <body>

    <div id="authing-guard-container"></div>



    <script>

      const guard = new GuardFactory.Guard({

        // 你可以前往 Authing 控制台的本应用详情页查看你的 APP ID

        appId: "AUTHING_APP_ID",



        // 如果你使用的是私有化部署的 Authing 服务，需要传入自定义 host，如:

        // host: 'https://my-authing-app.example.com',



        // 默认情况下，会使用你在 Authing 控制台中配置的第一个回调地址为此次认证使用的回调地址。

        // 如果你配置了多个回调地址，也可以手动指定（此地址也需要加入到应用的「登录回调 URL」中）：

        // redirectUri: "YOUR_REDIRECT_URI"

      });



      // 挂载 Authing Guard

      guard.start("#authing-guard-container");

    </script>

  </body>

</html>

无论通过哪一种方式，你都可以完成 Authing Guard 在你项目中的安装和初始化。

获取 Guard 实例

// 代码示例：https://github.com/Authing/Guard/blob/v5/examples/guard-vue2/normal/src/views/Home.vue

export default {

  created() {

    console.log("guard instance: ", this.$guard);

  },

};

5. 常见问题

Q：如何找到ANTHROPIC API开放平台

A：幂简集成是国内领先的API集成管理平台，专注于为开发者提供全面、高效、易用的API集成解决方案。幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’身份云API开放平台‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。

Q：使用应用公钥验证 RS256 算法签名的 IdToken？
A：如果使用 RS256 签名算法，需要使用公钥验证签名。Authing 将使用应用的私钥进行签名，请使用 https://<应用域名>.authing.cn/oidc/.well-known/jwks.json 中的公钥来验证签名。Authing 颁发的 access_token 和 id_token 都可以使用上述公钥进行验签。

Authing 的用户池中存在多种类型的应用，包括：自建应用、集成应用，以及可以收纳这两种应用进行单点登录（SSO）的应用面板。默认状态下， Authing 用户池中以上各种类型的应用使用独立的三级域名（xxx.authig.cn），你可以独立地修改任何一个自建应用以及应用面板的认证地址。

与此对比，统一域名指的是同一个用户池中各种类型的应用均使用同样的三级域名。创建此类用户池之后，你可以在用户池 设置->基础设置->基础信息 标签页对此用户池统一的三级域名进行修改。你的修改将会对该用户池中的所有应用同时生效，不同应用之间将会通过在认证地址后拼接 App ID 的方式进行区分（xxx.authing.cn/APP_ID）。

Q：什么情况不建议使用统一域名？
A：

你希望每个应用的三级域名能够被自定义。
你接受使用 Authing 默认的二级域名（即 .authing.cn）。

Q：使用托管登录页面？
A：

在 Authing 控制台定义一个用户自定义字段（如 source），用于存储用户的来源数据，详情请见添加自定义用户字段。
访问应用域名的时候带上指定的 query 参数，如 https://your-app.authing.cn?source=someWhere。
当用户登录注册的时候，Authing 将会将此数据写入到用户的自定义字段中。
之后你可以使用 Authing 提供的 SDK 管理用户的自定义字段，详情请见 SDK – 管理自定义数据。

Q：使用嵌入登录组件?

A：

在 Authing 控制台定义一个用户自定义字段（如 source），用于存储用户的来源数据，详情请见添加自定义用户字段。
在 Guard 组件所在页面的 URL 上添加同样的 Query 参数，如 ?source=someWhere。当用户使用 Guard 组件注册时，将会将这个参数写入到用户的自定义字段中。
之后你可以使用 Authing 提供的 SDK 管理用户的自定义字段，详情请见 SDK – 管理自定义数据。

Q：身份云API开放平台的替代品有哪些？

除了身份云API开放平台，还有其他替代服务商也提供类似api服务，例如：

CYBERARK API开放平台、ConnectionPoint API开放平台、Passbolt API开放平台

更多竞品可以在幂简集成开放平台中找到。

Q：身份云API开放平台这个密钥还适用于哪些api？

使用 SDK 导入用户、从企业微信、钉钉等第三方身份源导入用户、配置登录失败次数限制

6. 总结

本文全面且细致地阐述了如何获取身份云API开放平台访问密钥的分步指南，为开发者们提供了一份条理清晰、操作简便的实用手册。从身份云API平台的账号注册，到完成开发者身份认证，再到最终成功获取访问密钥，每一步操作都配以详尽的说明与指导，确保开发者能够轻松、准确地完成整个流程。获取访问密钥只是利用身份云API的第一步，如何高效、安全地集成并应用这些强大的身份验证与数据管理功能才是关键。因此，在本文中，我们不仅指导了如何获取访问密钥，还强调了获取后进行初步测试与验证的重要性。通过测试，开发者可以确保身份云API能够顺利集成到应用中，并发挥出最佳效果，从而提升应用的安全性和用户体验。本文为开发者们提供了一个全面、详尽且极具实用性的操作指南，帮助他们顺利获取身份云API开放平台的访问密钥，并将这一强大的身份验证与数据管理功能高效地集成到应用中。我们相信，随着开发者们对这一指南的深入理解和实践，将能够在身份认证与数据管理领域取得更加显著的成果，为应用的安全性和用户体验注入新的活力。