注册公共 API 客户端

我们建议开发人员在 沙盒测试服务器 在使用生产版本之前。 以下是有关如何在沙盒和生产环境中注册公共 API 凭证的步骤。

• 登录你的 ORCID 记录：
  生产服务器： https://orcid.org/signin
  沙盒测试服务器： https://sandbox.orcid.org/signin
• 在右上角点击你的名字
• 点击 开发者工具 从菜单选项
  注意： 为了访问开发人员工具，您必须验证您的电子邮件地址。 如果您尚未验证您的电子邮件地址，系统会提示您进行验证，然后才能注册公共 API 凭据
• 阅读并同意‘ORCID 公共 API 服务条款
• 点击“注册 ORCID 公共 API 凭证”按钮。

填写申请详情表

• 注册公共 API 凭证后，您将被引导回开发人员工具（https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• 您需要填写提交的申请详细信息表以注册新申请。
  • 姓名：您的应用程序的名称。 当用户授予您的应用程序权限以获取他们的权限时，这将显示给用户 ORCID iD，它将显示在他们的 受信任组织列表. 我们建议使用您的组织或服务的名称（例如期刊名称）。
  • 申请网址： 用户可以访问该网站以了解有关您的应用程序的更多信息。 这也将显示在他们的 受信任组织列表.
  • 应用说明：有关您正在开发的应用程序以及您将如何使用用户的应用程序的信息 ORCID ID。 这将在 OAuth 屏幕上向用户显示。

添加 重定向 URI

用户授权您的应用程序后，他们将返回到您指定的 URI。 您必须提前提供这些 URI，否则您的集成用户将遇到错误。

• 在提供的框中输入您的重定向 URI
• 如果您需要输入超过 1 个重定向 URI，请单击“添加另一个重定向 URI”

请注意：

• 只有 HTTPS URI 已在生产中接受
• 已注册的域 必须 与使用的域完全匹配，包括子域
• 尽可能完整注册所有重定向 URI。 这是最安全的选项，也是我们推荐的选项。 有关重定向 URI 的更多信息，请参阅我们的 重定向 URI 常见问题解答

保存您的申请

填写完申请表并添加重定向 URI 后，您可以保存您的申请。

• 点击“保存我的申请并生成我的客户端 ID 和密钥”

您将被引导回开发人员工具页面，该页面现在将包含您的公共 API 客户端凭据

更新您的凭据

更改您的申请信息非常简单。

• 编辑相关信息，然后点击“保存申请”

使用您的凭据

现在您已拥有凭据，是时候开始使用 ORCID 公共API！

请注意，如果您成为会员，我们可以将您的凭据传输到会员 API ORCID 会员 在未来。

ORCID 根据您使用的 API 支持不同的 API 使用配额和速率限制。 

请求第二个 是每秒可以发出的请求数。 

连发 是我们在拒绝之前允许排队的请求数。队列中的请求将减慢到每秒请求的速率。如果超出了突发速率，您将收到 503 响应。 

如果您超出使用配额，那么您将无法在该时间范围内提出进一步的请求。 

请记住 ORCID 公共 API 可供个人免费使用，如 公共 API 服务条款。“非商业”是指您不得对公共 API 收取任何重复使用费用，也不得将公共 API 用于任何创收产品或服务。 

使用带有客户端凭据的公共 API 将使您的集成获得比匿名 API 更高的使用配额。请参阅我们的 整合指南 关于如何注册公共 API 客户端。 

如果你经常超出公共 API 的使用配额，那么我们建议你考虑成为 ORCID 会员可访问我们的 会员API。它不仅允许您访问更高的速率限制和不受限制的使用配额，而且您将能够访问受信任方数据 ORCID 记录并提供数据 ORCID 在获得用户许可的情况下，从您的机构系统中获取记录。