레지스트리 및 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 및 그 반대를 사용하여 3-legged 범위를 요청하지 않았는지 확인합니다.
상호 작용 권한을 요청할 때 ORCID 사용자 레코드에 하나 이상의 '범위'를 지정합니다. 각 범위를 사용하면 레코드 읽기 또는 특정 섹션 업데이트와 같은 특정 작업을 수행할 수 있습니다.
3 다리 사용자로부터 허가를 얻는 데 관여하는 세 명의 행위자를 의미합니다. ORCID, 시스템 및 사용자 자신.
/ 인증
이 범위는 ORCID iD 기록에 있는 공개 정보만 읽으십시오. 다른 모든 3-legged 범위에는 인증 권한이 포함되어 있으므로 다른 액세스를 요청하는 경우 이 범위를 생략할 수 있습니다. 이 범위는 Member 또는 Public API에서 사용할 수 있습니다.
/ read-limited (멤버 API 전용)
이 범위는 공개 및 제한된 가시성 항목을 읽기 위해 액세스하는 데 사용됩니다. ORCID 기록. 이 범위는 Member API에서만 사용할 수 있습니다.
/ activities / update (멤버 API 만 해당)
이 범위는 소속, 자금 조달, 작업, 전문 활동, 연구 리소스 및 동료 검토 섹션의 항목을 작성, 업데이트 및 삭제하는 데 사용됩니다. ORCID 기록. 이 범위는 Member API에서만 사용할 수 있습니다.
/ person / update (멤버 API 만 해당)
이 범위는 레코드의 다른 이름, 키워드, 국가, 연구원 URL, 웹 사이트 및 개인 외부 식별자 섹션에서 항목을 작성, 업데이트 및 삭제하는 데 사용됩니다. 이 범위는 Member API에서만 사용할 수 있습니다.
openid
이 범위는 id_token이 필요할 때 OpenID 통합자가 사용합니다. openid 범위가 포함되면 레지스트리는 토큰 응답 내에서 id_token을 반환하고 해당 사용자의 사용자 정보 끝점에 액세스 할 수있는 클라이언트 권한을 부여합니다. 이 범위는 공용 및 멤버 API에서 사용할 수 있습니다.
'openid'범위는 다른 것과 같이 '/'로 시작하지 않습니다. ORCID API 범위. 이것은 'openid'범위가 다음에 의해 정의되지 않았기 때문입니다. ORCID이지만 대신 OpenID Connect 사양에 의해 정의됩니다. 우리를 참조하십시오 OpenID 문서
여러 범위
scope = / read-limited % 20 / activities / update % 20 / person / update와 같이 각각 사이에 인코딩 된 공백을 사용하여 인증 URL에 범위를 나열하여 단일 상호 작용에서 여러 범위를 요청할 수 있습니다.
완전한 액세스
레코드를 읽고 편집하기위한 전체 액세스 권한을 원하는 경우 인증 URL에 / read-limited, / activities / update 및 / person / update의 세 가지 범위가 포함됩니다. URL에서는 scope = / read-limited % 20 / activities / update % 20 / person / update로 표시됩니다.
2-legged (클라이언트 자격 증명) 범위
일부 활동의 경우 사용자에게 권한을 요청할 필요가 없습니다. Two legged OAuth 범위는 ORCID API이며 연구원에게 허가를 요구하지 않습니다. 이러한 범위의 토큰은 20 년 동안 유효하며 재사용 할 수 있습니다.
/ 공개 읽기
이 범위는 하나의 공개 정보를 읽는 데 사용됩니다. ORCID 아이디,검색 ORCID 기록 또는 요약 정보 읽기(회원 API에만 해당) 이 범위는 회원 또는 공개 API에서 사용할 수 있습니다.
/ webhook
이 범위를 사용하면 클라이언트 애플리케이션이 웹훅을 ORCID 레코드가 업데이트 될 때 알림을 수신하기 위해. 이 범위는 프리미엄에 사용할 수 있습니다. ORCID 회원 전용.
두 가지 다른 업데이트 범위가 있습니다. 하나는 전기 정보 용이고 다른 하나는 활동 용입니다.
범위 | 상품 설명 | API 엔드 포인트 |
/ person / update | 약력 데이터 - 왼쪽 열 ORCID 기록 사용자 인터페이스. | /주소 / 외부 식별자 / 키워드 /다른 이름들 / researcher-urls |
/ activities / update | 연구 활동 데이터 - 오른쪽 열 ORCID 기록 사용자 인터페이스. | /구별 / distinctions /교육 / educations /고용 / 고용 / 펀딩 / fundings / 초대 위치 / 초대 위치 / 회원 / 멤버십 / 동료 검토 / peer-reviews /자격 /자격 / research-resource / research-resources /서비스 /서비스 /작업 /공장 |
레지스트리 오류 메시지
일반적으로 사용자는 애플리케이션과의 연결을 승인 할 때 몇 가지 API 관련 오류 만 발생합니다.
잘못된 리디렉션 URI
리디렉션 URI가 등록 된 리디렉션 URI와 일치하지 않습니다.
이 오류 메시지는 인증 링크가 API 클라이언트 자격 증명에 등록하지 않은 리디렉션 URI를 지정 함을 나타냅니다. 공용 API를 사용하는 경우이 문제를 직접 수정할 수 있습니다. 개발자 도구. Member 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 팀.