통합 시작하기

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

주의 사항: 다음을 사용하는 경우 ORCID 이미 지원하고 있는 인증된 서비스 제공업체 시스템 ORCID, 샌드박스 API 자격 증명을 시험해 보기를 원하지 않는 한 등록할 필요가 없습니다. ORCID 샌드박스 환경 내 통합 기능. 

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

테스트 계정 만들기

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

우편물 이메일 주소

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

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

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

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

/ 공개 읽기

이 범위는 하나의 공개 정보를 읽는 데 사용됩니다. ORCID 아이디,검색 ORCID 기록 또는 요약 정보 읽기(회원 API에만 해당) 이 범위는 회원 또는 공개 API에서 사용할 수 있습니다.

/ webhook

이 범위를 사용하면 클라이언트 애플리케이션이 웹훅을 ORCID 레코드가 업데이트 될 때 알림을 수신하기 위해. 이 범위는 프리미엄에 사용할 수 있습니다. ORCID 회원 전용.

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

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

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

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

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

회원 단체 요청 ORCID 프로덕션 (라이브) 서버에서 멤버 API 자격 증명을 완료하여 Production Member API 클라이언트 신청서. 목록에 없는 공급업체 시스템을 사용하는 경우 ORCID 인증 된 서비스 제공 업체, 통합은 다음을 보장하기 위해 검토 프로세스를 거쳐야 합니다. 통합을 위한 최소 요구 사항 및 모범 사례 만났습니다. 

인증되지 않은 서비스 제공자에게 연락하여 최소 기준이 충족되었다는 증거를 직접 얻을 수 있습니다. 이 증거를 다음 주소로 보내야 합니다. ORCID 참여팀이나 컨소시엄 리더에게 문의하세요.

이 증거를 공유하는 방법에는 몇 가지가 있습니다.

1. 스크린캐스트 또는 스크린샷: 각 단계에서 통합이 어떻게 작동하는지 명확하게 설명하고 보여주는 설명이 있는 녹음본이나 스크린샷 세트를 보내세요. 여기에는 사용자가 액세스를 거부하거나 iD 연결을 끊을 경우 어떻게 되는지 포함됩니다. 사용된 API 버전과 데이터가 저장되는 방식 등 사용자 측에서 볼 수 없는 내용을 확인하기 위해 추가 문서를 제공해야 합니다.
2. 공개적으로 사용 가능한 통합 문서: 각 단계에서 통합이 어떻게 작동하는지에 대한 명확한 설명이 포함된 공개적으로 접근 가능하고 최신의 링크를 제출합니다. 옵션 1에서와 같이, 사용된 API 버전과 데이터가 저장되는 방식과 같이 사용자 측에서 볼 수 없는 모든 것을 확인하기 위한 추가 문서를 제공해야 합니다.

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

조직명: 당신 ORCID 회원단체명

자격 증명의 기본 연락처 이메일 주소: 우리는 이 이메일 주소를 사용하여 암호화된 이메일로 자격 증명을 보내고, 통합과 관련하여 질문이나 오류가 발생할 경우 연락을 드릴 것입니다.

비밀번호에 대한 보조 이메일: 암호화된 이메일 비밀번호를 보낼 수 있는 이메일 주소입니다.

고객 이름: 이것은 당신의 것입니다 ORCID 회원단체명. 통합이 1개 이상인 경우 이름에 애플리케이션을 추가합니다.

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

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

리디렉션 URI : 사용자가 애플리케이션을 승인하면 지정한 URI로 반환됩니다. 이러한 URI를 미리 제공해야 합니다. 그렇지 않으면 통합 사용자에게 오류가 발생합니다. 

• HTTPS URI만 허용됩니다.
• 등록된 도메인은 하위 도메인을 포함하여 사용된 도메인과 정확히 일치해야 합니다.   
• 가능한 경우 모든 리디렉션 URI를 완전히 등록합니다. 
• 5개 이상의 리디렉션 URI가 필요합니까? 에 대한 참고 사항에 이를 표시하십시오. ORCID 직원.

참고 사항 ORCID 직원:이 필드를 사용하여 ORCID 직원은 귀하의 요청이나 통합에 대해 추가 정보를 알고 있습니다.

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

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

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