ORCID 提供多种 API，允许您的系统连接到 ORCID 注册表，包括读取和写入 ORCID 记录。 某些 API 函数可供任何人免费使用（公共API); 其他人只能使用 ORCID 会员组织（会员和高级会员 API）。 任何人都可以在我们的沙盒测试服务器上自由测试我们的任何 API。
在开始之前
当您开始进行集成规划时，您应该考虑：
- 你想用 ORCID API——请访问我们的 工作流程 和 集成最佳实践。 如果你是一个 ORCID 成员组织您可以联系我们或您的财团领导寻求帮助！。
- 您使用的系统是否已经支持 ORCID。如果是的话，这可能就像配置您的系统一样简单 ORCID。 请检查我们的 ORCID 认证服务提供商名单 查看你的系统是否包含在内
- 您将如何与您的研究人员就正在实施的更改进行交流，您需要从他们那里得到什么，他们的好处以及他们需要做什么。 访问我们的 外联资源 页面，了解如何围绕新集成构建沟通活动。我们还建议您观看我们的网络研讨会 '我现在是一个会员了？！如何谈论 ORCID和
注册沙箱凭据并创建测试 ORCID iD
如果您正在构建自定义集成或使用未经认证的服务提供商应用程序，那么我们要求您首先使用我们的沙盒环境来构建和测试您的集成。
您还可以 请求沙箱会员 API 凭证 构建和测试您的应用程序。这些凭据允许您调用 sandbox 高级会员 API 来读取、写入和更新 ORCID 记录。 任何人都可以免费访问沙盒测试环境，即使您不是 ORCID 会员组织。
注意：：如果您使用的是 ORCID 认证服务提供商 已经支持的系统 ORCID，除非你想尝试 ORCID 沙盒环境中的集成功能。
沙箱让您可以创建测试用户帐户并开发您的集成，而不必担心影响实时（生产）上的数据 ORCID 注册表。 沙箱的行为方式与生产相同 ORCID 注册与 一些例外.
创建测试帐户
为了测试 ORCID API 和 API 调用，例如读取和添加信息到 ORCID 记录，您还需要创建一个测试 ORCID 记录在沙箱中。 这可以通过用户界面完成，就像在生产中一样 ORCID 注册表。 去 https://sandbox.orcid.org/register 并注册一个帐户。
邮寄者电子邮件地址
沙盒服务器仅向 Mailinator (@mailinator.com) 电子邮件地址，以免无意中向邮件服务器发送垃圾邮件。 除非您使用@mailinator.com 地址，否则您不会收到验证电子邮件或密码重置通知，并且需要验证才能对沙盒记录进行任何手动编辑。 详细了解他们免费使用的公共收件箱 点击此处。
Mailinator 是一种具有公共免费服务和私人付费服务的电子邮件服务。 对于测试，您可以使用完全免费的公共服务。 了解更多关于他们的等级 开始.
Mailinator 是第三方服务，不受管理或维护 ORCID. 我们建议您在使用这些地址之前查看此服务的工作原理及其限制。
确定您需要的用户权限
此 ORCID 会员 API 可用于读取、添加或更新用户的信息 ORCID 记录——你只需要向研究人员请求许可。
当请求与某个人交互的权限时 ORCID 用户的记录，您指定一个或多个“范围”。 每个范围都允许您执行某些操作，例如读取记录或更新特定部分。
3条腿 指获取用户许可所涉及的三个参与者； ORCID，您的系统和用户自己。
/认证 
此范围用于收集 ORCID iD 并仅阅读记录中的公共信息。 所有其他 3-legged 范围都包含身份验证权限，因此如果要求任何其他访问权限，则可以省略此范围。 此范围在成员或公共 API 上可用。
/read-limited（仅限会员 API） 
此范围用于访问读取公共和有限可见性项目上的 ORCID 记录。 此范围仅在成员 API 上可用。
/activities/update（仅限会员 API） 
此范围用于编写、更新和删除期刊的隶属关系、资金、著作、专业活动、研究资源和同行评审部分的项目。 ORCID 记录。 此范围仅在成员 API 上可用。
/person/update（仅限会员 API）
此范围用于写入、更新和删除记录的其他名称、关键字、国家/地区、研究人员 URL、网站和个人外部标识符部分中的项目。 此范围仅在成员 API 上可用。
Openid
当需要 id_token 时，OpenID 集成商使用此范围。 当包含 openid 范围时，注册表将在令牌响应中返回一个 id_token 并授予客户端访问该用户的用户信息端点的权限。 此范围在公共和成员 API 上可用。
请注意，“openid”作用域不像其他作用域那样以“/”开头 ORCID API 范围。 这是因为“openid”范围不是由 ORCID，而是由 OpenID Connect 规范定义。 请看我们的 OpenID 文档 获取更多信息。
多个范围
通过在身份验证 URL 中列出范围并在每个范围之间使用编码空格，可以在单个交互中请求多个范围，例如 scope=/read-limited%20/activities/update%20/person/update
完全访问
如果您想要读取和编辑记录的完全访问权限，请在您的身份验证 URL 中包含三个范围：/read-limited、/activities/update 和 /person/update。 在 URL 中，它们将显示为 scope=/read-limited%20/activities/update%20/person/update
2-legged（客户端凭据）范围
对于某些活动，您不必征得用户许可。 直接从 ORCID API，不需要研究人员授予许可。 具有这些范围的令牌的有效期为 20 年并可重复使用
/读公开
此范围用于读取有关单个的公共信息 ORCID iD，搜索 ORCID 记录或读取摘要信息（仅限会员 API）。此范围在会员或公共 API 上可用。
/ webhook
此范围允许客户端应用程序在 ORCID 记录，以便在记录更新时接收通知。 此范围适用于高级 ORCID 内部使用。
确保您可以安全地存储数据
重要的是您的系统能够存储信息 以安全的方式.
集成需要存储的不仅仅是 ORCID 记录。 您的系统需要能够：
- 接受并存储 ORCID iD：您的系统需要知道 iD 的 ORCID 记录显示 iD 并正确更新。将其与令牌交换响应中返回的研究人员信息一起存储。我们的建议是存储完整的 https URI： https://orcid.org/0000-0001-5727-2427.
- 接受并存储持久化 访问令牌 和 刷新令牌：访问令牌可用于读取和更新记录，以及指示 iD 已通过身份验证。访问令牌的有效期约为 20 年，或直到用户撤销它们为止。我们还建议您存储 令牌范围, 令牌到期 和 刷新令牌。如果需要，可以使用刷新令牌创建具有相同或有限范围的新访问令牌。将访问令牌令牌数据与研究人员的信息一起存储。
- 接受并存储 把代码 ：您添加到的每项 ORCID 注册表将返回一个放置代码 ORCID API。将此 6 位数的放置代码与系统中的项目一起保存，这样您就可以识别需要读取、更新或删除哪个项目。
- 当交互未按预期进行时，提供错误消息和支持联系人。
与 ORCID 团队或联盟领导来展示你的应用程序是如何运作的
在您的集成上线之前 ORCID 生产注册表，我们的参与团队或您的联盟领导将仔细检查您在沙盒中构建的所有内容是否也适用于生产。如果您使用的是 ORCID 认证服务提供商系统可以跳过此步骤。我们有一份 最低要求 在我们颁发会员 API 生产凭证之前，需要满足这些条件。
会员组织要求 ORCID 通过完成生产（实时）服务器上的成员 API 凭据 生产会员API客户端申请表. 在发布生产会员 API 凭证之前， ORCID 参与团队/联盟领导将审查您在 ORCID 沙盒。这让我们有机会看到您构建的出色集成并提供工作流程改进，以及检查所有集成是否符合我们的最佳实践和发布的最低要求。
要提供您的系统的演示，您需要设置与 ORCID 沙箱 ORCID 团队可以预览。 有几种方法可以共享您的工作沙箱集成：
- 推荐： 现场演示： 联系我们安排现场演示。我们将提供会议软件，让您共享您的屏幕，以便您演示您的集成。
- 测试地点： 如果您的开发站点是公开的， 把网址发给我们 以及访问系统的测试凭据（如果需要）和描述如何使用系统的说明 ORCID 特征。 提供额外的文档以验证我们无法从用户端看到的内容，例如使用的 API 版本、您的系统存储了哪些数据等。
- 截屏或截图：发送录音或一组截图 提供清晰的描述，说明和演示您的集成在每个步骤中的工作方式，包括如果用户拒绝访问或断开其 ID 连接会发生什么情况。请务必提供其他文档来验证我们无法从用户端看到的任何内容，例如使用的 API 版本以及数据的存储方式
请求会员 API 凭证
一旦您的集成通过审核，您就可以申请成员 API 凭证 ORCID 团队或如果你正在使用 ORCID 认证服务提供商体系。
您需要填写 用于注册客户端应用程序的表单. 以下是请求字段的快速概览：
是否更新现有凭证？： 如果您已经拥有生产凭证并且只想更新现有凭证。
请告诉我们有关您的组织的更多信息： 帮助我们更好地了解您的组织，以便我们能够正确地指导您的询问
名字是什么 ORCID 您代表哪个成员组织申请凭证？：您请求凭证的成员组织的名称（不一定是您的组织）
您的组织名称是什么（如果与上述不同）： 如果您请求的是其他组织的凭证，请在此处输入您所在组织的名称
请确认您请求生产会员 API 凭证的系统集成类型：如果您请求除认证服务提供商以外的任何凭证，那么您需要在 ORCID 沙盒环境并演示 ORCID 在授予生产会员 API 凭证之前，需要获得会员支持团队的支持。
请确认您是否会要求研究人员验证他们的 ORCID 与系统/服务交互时，或者您是否有公共数据的只读用例，这不需要 ORCID 记录持有者与您的系统/服务进行交互：请告知我们您是否需要 ORCID 记录持有者与您的系统交互，或者您只是从 ORCID 无需身份验证即可注册。
凭证的主要联系电子邮件地址： 我们将使用此电子邮件地址以加密电子邮件的形式向您发送凭证，并在您集成时出现任何问题或错误时与您联系
密码的辅助电子邮件：我们可以向其发送您的加密电子邮件密码的电子邮件地址。
您的客户端应用程序的名称： 这将是你的 ORCID 成员组织名称。如果您有多个集成，那么我们会将应用程序附加到名称中。
您的应用程序主页的 URL： 在用户信任的组织列表中显示为链接 ORCID 受信任方页面。 这应该是返回您的组织或应用程序主页的链接。
您的客户端应用程序的简短描述：此文本将在授权屏幕上显示，并带有问号图标，供您的集成用户使用。需要对您的集成进行简短描述
重定向URI： 用户授权您的应用程序后，他们将返回到您指定的 URI。 您必须提前提供这些 URI，否则您的集成用户将遇到错误。
- 仅接受 HTTPS URI。
- 注册的域名必须与使用的域名完全匹配，包括子域名。
- 尽可能完整注册所有重定向 URI。
- 需要超过 5 个重定向 URI？ 请在备注中注明 ORCID 工作人员。
注意事项 ORCID 员工: 使用这个字段让 ORCID 工作人员是否了解您的请求或融入情况的其他信息
将您的申请转移到 ORCID 生产登记处
获得凭证后，您就可以开始使用集成了。如果您想在集成向公众发布之前对其进行测试，请使用测试人员自己的 ORCID 记录或同事的 ORCID 记录。
启动——并让所有人知道
使应用程序上线并不是最后一步——您需要继续与您的用户沟通，以便他们知道将他们的 ORCID iD 快速轻松地连接到您的系统。 有效的集成包含技术组件（本指南涵盖）和社交组件。 研究人员需要被告知什么 ORCID 是，为什么您要求访问他们的 ORCID 记录，以及您将如何处理他们的数据。
- 创建沟通时间表：确保利益相关者了解您的 ORCID 在您启动之前做好项目。
- 结合使用自上而下和自下而上的沟通方式。
- 推广你的 ORCID 经常和不同的受众进行整合。
- 创建本地资源 为您的用户提供支持，例如常见问题解答、libguides、网页、教程和视频。
- 指定当地联系人 ORCID-相关问题。
如果您需要任何帮助，请联系您的参与负责人或您的联盟负责人