我们尽最大努力在我们的注册表和 API 中提供描述性错误消息。 以下是一些提示,可帮助您解决可能遇到的任何错误。
API错误
我们的 API 错误代码包含应该易于理解的描述性消息。
XML/JSON 格式错误
如果您在格式化您尝试添加或更新的数据时遇到问题 ORCID 记录,我们建议通过以下方式咨询示例:
- 发送调用以读取记录或单个项目以接收示例 XML/JSON,或者,如果您正在更新记录,则是您正在更新的项目的完整 XML/JSON,并以此为起点
- 咨询我们的 示例 XML 和 JSON 文件 在我们的 GitHub 存储库中——我们有干净的 XML/JSON 用于发布和完整的 XML/JSON 用于读取示例
在您可以将项目添加到 ORCID 记录您需要将数据格式化为 ORCID 架构。 格式化您的数据 ORCID XML 或 JSON 中的消息模式。
我们的 GitHub 存储库包含在创建新项目时有助于格式化的资源 ORCID 记录,并在阅读现有项目时 ORCID 记录:
请注意,不同版本的 API 具有不同的消息格式。 版本 2.0 和 2.1 模式和示例也可用.
通过阅读填充良好的记录的元数据,可以轻松找到更多示例。
范围错误
如果您收到与范围相关的错误,那么我们建议您:
- 检查您没有将成员范围用于公共 API 客户端。
- 如果您正在添加、更新或读取具有执行操作的正确范围的有限可见性数据。
- 检查您是否没有使用 2-legged OAuth 和 vis-versa 请求 3-legged 范围。
当请求与某个人交互的权限时 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 上可用。
/ webhook
此范围允许客户端应用程序在 ORCID 记录,以便在记录更新时接收通知。 此范围适用于高级 ORCID 内部使用。 如果您不是高级会员,但希望在开发者沙盒中测试此功能,请 CONTACT ORCID 用户社区.
- 以往 ORCID 支持其他范围,现在已经 逐步淘汰.
- 你可以找出来 在此处添加或更新特定部分需要哪些范围.
有两种不同的更新范围 - 一种用于传记详细信息,另一种用于活动。
范围 | 产品描述 | API端点 |
/人/更新 | 个人资料-左栏 ORCID 记录用户界面。 | /地址 /外部标识符 /关键词 /其他名称 /研究人员网址 |
/活动/更新 | 研究活动数据-右栏 ORCID 记录用户界面。 | /区别 /区别 /教育 /教育 /就业 /就业 /资金 /资金 /邀请位置 /邀请职位 /会员 /会员 /同行评审 /同行评审 /资格 /资格 /研究资源 /研究资源 /服务 /服务 /工作 /作品 |
注册表错误信息
通常,您的用户在授权与您的应用程序连接时只会遇到一些与 API 相关的错误:
错误的重定向 URI
重定向 URI 与您注册的重定向 URI 不匹配。
此错误消息表明您的授权链接指定了您尚未在 API 客户端凭据中注册的重定向 URI。 如果您使用的是公共 API,则可以在您的 开发者工具. 如果您使用的是会员 API,则需要请求 ORCID 参与团队更新您的凭据。
找不到请求的页面。 如果您将此页面添加为书签,请删除它。 如果您点击了链接,请举报。
当 OAuth 授权链接格式不正确时,往往会出现此错误,例如 https://orcid.org/signin/oauth/authorize?[….] 而不是 https://orcid.org/oauth/authorize?[…]. 要解决,只需更正链接即可。
非描述性消息
服务器出现问题。 如果此问题仍然存在,请联系支持人员。
当未指定范围时,最常发生此错误。 您必须在 OAuth 授权链接中包含一个范围; 最小范围是/authenticate。
检查是否 ORCID 正在工作中!
这是非常非常罕见的,但是如果您认为错误是 ORCID 您可以查看的服务器 http://status.orcid.org/
请注意 ORCID Sandbox 没有服务级别协议,在我们发布代码更新时可能会关闭 20 分钟。
获得帮助
我们随时乐意为您服务! ORCID 会员组织可以获得 支持 ORCID 直。
也鼓励所有集成商加入 ORCID API用户组,您可以在其中与其他集成商和 API 用户进行交流,以及 ORCID 球队。