통합 시작하기

당신은 할 수 있습니다 샌드 박스 멤버 API 자격 증명 요청 애플리케이션을 빌드하고 테스트합니다. 이러한 자격 증명을 사용하면 샌드 박스 멤버 API를 호출하여 읽고, 쓰고, 업데이트 할 수 있습니다. ORCID 기록. 샌드 박스 테스트 환경에 대한 액세스는 사용자가 아니더라도 누구나 무료로 사용할 수 있습니다. ORCID 회원 조직.

주의 사항: 이미 지원하는 타사 시스템을 사용하는 경우 ORCID, 샌드 박스 API 자격 증명을 등록 할 필요가 없습니다. 

샌드 박스를 사용하면 라이브 (프로덕션) 데이터에 영향을주지 않고 테스트 사용자 계정을 만들고 통합을 개발할 수 있습니다. ORCID 기재. 샌드 박스는 프로덕션과 동일한 방식으로 작동합니다. ORCID 레지스트리 몇 가지 예외.

테스트 계정 만들기

테스트하려면 ORCID API 및 API 호출(예: 정보 읽기 및 추가) ORCID 기록하려면 테스트도 만들어야합니다. ORCID 샌드 박스에 기록합니다. 이는 프로덕션에서와 같이 사용자 인터페이스를 통해 수행 할 수 있습니다. ORCID 기재. 이동 https://sandbox.orcid.org/register 계정을 등록하십시오.

우편물 이메일 주소

샌드 박스 서버는 알림 이메일을 메일 레이터 (@mailinator.com) 메일 서버에 실수로 스팸 메일을 보내지 않도록 이메일 주소. @mailinator.com 주소를 사용하지 않으면 확인 이메일이나 비밀번호 재설정 알림을 받지 못하며 샌드박스 레코드를 수동으로 편집하려면 확인이 필요합니다. 무료 공개 받은편지함에 대해 자세히 알아보기 여기를 클릭하세요. 사용을 원하지 않으시면 메일 레이터 주소를 입력한 다음 사용자 이름과 비밀번호를 기록하고(테스트할 때 애플리케이션에 권한을 부여하는 데 사용하므로) 당사에 연락하여 확인 지원을 요청하십시오.

메일 레이터 는 공개 무료 서비스와 비공개 유료 서비스가 있는 이메일 서비스입니다. 테스트를 위해 완전 무료 공공 서비스를 사용할 수 있습니다. 등급에 대해 자세히 알아보기 here.

Mailinator는 ORCID. 이러한 주소를 사용하기 전에이 서비스의 작동 방식과 제한 사항을 검토하는 것이 좋습니다. 

상호 작용 권한을 요청할 때 ORCID 사용자의 레코드에서 하나 이상의 '범위'를 지정합니다. 각 범위를 사용하면 레코드 읽기 또는 특정 섹션 업데이트와 같은 특정 작업을 수행 할 수 있습니다.

3-legged (인증 코드) 범위

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 (클라이언트 자격 증명) 범위

일부 활동의 경우 사용자에게 권한을 요청할 필요가 없습니다. 두 개의 다리가있는 OAuth 범위는 ORCID API이며 연구원에게 허가를 요구하지 않습니다. 이러한 범위의 토큰은 20 년 동안 유효하며 재사용 할 수 있습니다.

/ 공개 읽기

이 범위는 하나의 공개 정보를 읽는 데 사용됩니다. ORCID iD 또는 검색 ORCID 기록. 이 범위는 Member 또는 Public API에서 사용할 수 있습니다.

/ webhook

이 범위를 사용하면 클라이언트 애플리케이션이 웹훅을 ORCID 레코드가 업데이트 될 때 알림을 수신하기 위해. 이 범위는 프리미엄에 사용할 수 있습니다. ORCID 회원 전용. 프리미엄 회원이 아니지만 개발자 샌드 박스에서이 기능을 테스트하려면 연락 ORCID 커뮤니티.

• 과거에 ORCID 다른 범위를 지원했습니다. 단계적으로.
• 당신은 알아낼 수 있습니다 여기에서 특정 섹션을 추가하거나 업데이트하는 데 필요한 범위.

통합은 그 이상을 저장해야합니다. ORCID 기록. 시스템은 다음을 수행 할 수 있어야합니다.

• 수락 및 저장 ORCID iDs: 귀하의 시스템은 iD 의 ORCID 업데이트 할 기록. 연구원의 정보와 함께 저장하십시오. 전체 https URI를 저장하는 것이 좋습니다. https://orcid.org/0000-0001-5727-2427.
• 영속적 수용 및 저장 토큰에 액세스 및 토큰 새로 고침: 액세스 토큰을 사용하여 레코드를 읽고 업데이트할 수 있을 뿐만 아니라 iD 인증되었습니다. 영구 토큰은 약 20년 동안 또는 사용자가 취소할 때까지 유효합니다. 새로 고침 토큰을 사용하여 동일하거나 제한된 범위의 새 액세스 토큰을 만들 수 있습니다. 연구원의 정보와 함께 토큰을 저장합니다. 우리는 또한 당신이 저장하는 것이 좋습니다 토큰 범위, 그리고,토큰 만료.
• 수락 및 저장 코드를 넣다 (업데이트하는 경우 ORCID 기록) : 당신이 추가하는 모든 항목 ORCID 레지스트리는 입력 코드와 함께 반환됩니다. ORCID API. 이 입력 코드를 시스템의 항목과 함께 저장하십시오. 읽거나 업데이트해야 하는 항목을 식별하는 방법입니다.
• 상호 작용 기록 : 시스템은 ORCID API 및 응답을 받았습니다. 이것은 필요하므로 ORCID 나중에 문제가 발생하면 도움이 될 수 있습니다.
• 상호 작용이 예상대로 진행되지 않는 경우 오류 메시지와 지원 연락처를 제공합니다.

기관, 연구원 및 더 넓은 커뮤니티를위한 최상의 통합을 구축하려면 다음 모범 사례를 고려하는 것이 좋습니다.

• 사용자 경험을 사용자 지정합니다. 시스템에서 저장 한 데이터를 사용하여 OAuth 로그인 / 등록 화면을 미리 채 웁니다. 또한 상태 매개 변수를 포함하여 시스템에서 사용자를 식별하거나 표시 언어를 변경할 수 있습니다. ORCID.
• 사용자가 시스템 권한을 거부하는 경우 사용자에게 워크 플로를 제공합니다. ORCID 시스템이 권한을 요청하는 이유입니다. ORCID 기록하고 해당 권한으로 수행 할 작업을 확인하고 권한을 다시 부여 할 수있는 옵션을 제공합니다.
• 사용자가 제거 할 수있는 옵션을 제공하십시오. ORCID iD 및 시스템의 데이터: 드문 경우지만 사용자가 자신의 iD 시스템에서 또는 잘못 연결했을 수 있습니다. ORCID iD 활성 액세스 토큰도 시스템에서 동시에 취소되었는지 확인하십시오..
• 항목 고유의 넣기 코드를 사용하여 수정이 필요할 때 추가된 항목을 업데이트합니다.
• 상호 작용이 예상대로 진행되지 않는 경우 설명이 포함 된 오류 메시지와 지원 연락처를 사용자에게 제공합니다.
• 그 ORCID 회원 로고 (그것을 받으려면 저희에게 연락하십시오)
• 연결하여 일관된 사용자 경험을 만듭니다. iD 신뢰할 수 있는 어설션 프로세스가 있는 아이콘입니다. 우리의 ORCID 회원 및 파트너를위한 브랜드 가이드 라인s는 디스플레이 설정 프로세스를 안내합니다. iD 시스템의 아이콘과 아이콘을 표시할 때 해야 할 일과 하지 말아야 할 일에 대한 개요 ORCID 브랜드입니다.
• 액세스 토큰을 사용하여 기존 권한 확인 : 사용자로부터 권한을 한 번받은 후에는 다시 요청할 필요가 없습니다.

소셜 구성 요소를 지원하기 위해 우리는 다음 툴킷을 제공합니다. 아웃 리치 리소스 통합을 지원하는 캠페인을 개발하고 연구원과 소통하는 데 도움이됩니다.

• 뭐 ORCID 이다.
• 시스템이 iD를 수집하는 이유와 시스템이 레코드 업데이트와 같은 작업을 수행하는 방법.
• 연구자들이 ORCID iD 그리고 그들의 iD를 당신의 시스템에 연결합니다.
• 방법 ORCID 더 넓은 글로벌 연구 커뮤니티에 도움이됩니다.

우리는 커뮤니티의 피드백을 기반으로이 리소스 "라이브러리"를 지속적으로 구축 할 것입니다. 보고 싶은 아이디어가 있으시면 언제든지 문의 해주십시오.

회원 단체 요청 ORCID 프로덕션 (라이브) 서버에서 멤버 API 자격 증명을 완료하여 Production Member API 클라이언트 신청서. 프로덕션 멤버 API 자격 증명을 발급하기 전에 ORCID 참여 팀은 통합 데모를 검토합니다. ORCID 모래 상자. 이를 통해 구축 한 훌륭한 통합을 확인하고 워크 플로 개선을 제공 할뿐만 아니라 모든 통합이 모범 사례를 충족하는지 확인할 수 있습니다.

시스템 데모를 제공하려면 다음과의 작업 통합을 설정해야합니다. ORCID 샌드 박스 ORCID 팀은 미리 볼 수 있습니다. 작업중인 샌드 박스 통합을 공유하는 몇 가지 방법이 있습니다.

1. 권장 사항 : 라이브 데모 : 라이브 데모를 예약하려면 저희에게 연락하십시오. 통합 데모를 위해 화면을 공유할 수 있는 회의 소프트웨어를 제공합니다. 이것은 또한 귀하의 시스템이 어떻게 작동하는지, 그리고 귀하가 귀하의 시스템의 이점을 설명하는 방법에 대해 더 많이 배울 수 있는 기회를 제공합니다. ORCID 통합하여 귀하와 귀하의 사용자에게 더 나은 지원을 제공 할 수 있습니다.
2. 테스트 사이트 : 개발 사이트가 공개 된 경우 URL을 보내주세요 시스템에 액세스하기위한 테스트 자격 증명 (필요한 경우) 및 시스템의 사용 방법을 설명하는 지침과 함께 ORCID 풍모. 사용 된 API 버전, 시스템에 저장된 데이터 등 사용자 측에서 볼 수없는 내용을 확인하기 위해 추가 문서를 제공합니다.
3. 스크린 캐스트 또는 스크린 샷 (권장 ORCID데모가 필요한 지원 시스템) : 녹음 또는 스크린 샷 세트 보내기 사용자가 액세스를 거부하거나 iD 연결을 끊는 경우 발생하는 일을 포함하여 각 단계에서 통합이 어떻게 작동하는지 명확하게 설명하고 시연하는 설명과 함께. 사용된 API 버전 및 데이터 저장 방법과 같이 사용자 측에서 볼 수 없는 모든 사항을 확인하기 위해 추가 문서를 제공해야 합니다.¬¨‚

다음 중 하나를 사용하는 경우 ORCID데모가 필요없는 지원 시스템의 경우 직접 프로덕션 멤버 API 자격 증명 요청. 노트에 사용중인 시스템 (및 해당되는 경우 버전)을 지정해야합니다.

모든 멤버 통합이 충족 할 것으로 예상되는 여러 요구 사항이 있습니다. 그만큼 ORCID 팀은 통합 검토 프로세스의 일부로 이러한 요구 사항이 충족되었는지 확인합니다. 

• OAuth를 인증하다 ORCID iD (사용자가 검색하거나 입력하는 것을 허용하지 않음) ORCID iD.)
• 포함 ORCID 브랜드 버튼 또는 링크 사이트에서 iD 인증을 시작합니다.
• 우리에 따라 OAuth 인증 화면을 제시하십시오. 가이드 라인
• 사이트의 리디렉션 URI에 HTTPS를 사용하고 ORCID API 호출
• 시스템의 사용자 데이터와 함께 토큰 교환에서 반환 된 모든 데이터를 수락하고 저장합니다.
• 적절한 사용 범위 및 요청 방법 (예 : 새로운 정보를 추가하기위한 POST 호출과 기존 정보를 업데이트하기위한 PUT 호출)
• 인증 된 것을 공개적으로 표시 ORCID iD. iD는 다음과 같이 표시되어야합니다. 상표 및 iD 표시 지침.

모범 사례

통합이 모범 사례를 따르는 지 확인

당신은 채워야 할 것입니다 클라이언트 애플리케이션 등록 양식. 다음은 요청 된 필드에 대한 간략한 개요입니다.

참고 사항 ORCID 직원:이 필드를 사용하여 ORCID 공급 업체 시스템을 사용하고 있는지, 통합이 검토되었는지 등을 알 수 있습니다.

담당자 이메일 주소:이 주소로 자격 증명을 보냅니다. 이 연락처는 통합에 대해 함께 작업 한 연락처이거나 조직을 위해 보유한 기술 연락처 여야합니다.

자격 증명에 액세스하기 위해 PIN을 받기위한 연락처: 안전한 방법으로 전체 자격 증명을 전송합니다. 이 연락처에 API 자격 증명에 액세스하기위한 암호를 보내드립니다. 나열된 이전 연락처와 다른 연락처 여야합니다.

클라이언트 애플리케이션에 대한 간단한 설명:이 텍스트는 통합 사용자에게 물음표 아이콘과 함께 인증 화면에 표시됩니다. 통합에 대한 간단한 설명이 필요합니다.

애플리케이션 홈페이지의 URL: 사용자 내의 신뢰할 수있는 조직 목록에 링크로 표시됩니다. ORCID 신뢰할 수 있는 당사자 페이지. 이것은 조직 또는 애플리케이션의 기본 페이지로 돌아가는 링크여야 합니다.

클라이언트 용 OAuth2 리디렉션 URI 또는 ​​콜백 URL: 사용자가 액세스 권한을 부여한 후 반환 될 웹 애플리케이션의 허용 된 URL ORCID 기록 데이터. 모든 리디렉션 URI는 프로덕션 (라이브) 서버 클라이언트의 경우 HTTPS 여야합니다. 

요청을 하면 수동 프로세스가 발생하여 자격 증명을 발급하고 고객에게 이메일을 받게 됩니다. iD 그리고 클라이언트 비밀. 일반적으로 이러한 요청은 48시간 이내에 처리됩니다.