손에 ORCID API -

내용

1. 시작하기 전에 완료해야 할 사항

1.1. Sandbox 회원 API 자격 증명 요청

1.2. 샌드박스 만들기 ORCID 계정

1.3. Google OAuth 플레이그라운드 구성

2. 수집 인증 ORCID ID 및 권한

2.1. 액세스 토큰 및 인증된 ID에 대한 인증 코드 교환

3. 쓰기 ORCID 기록(POST)

4. 업데이트 ORCID 기록(PUT)

5. 독서 ORCID 기록(GET)

시작하기 전에 완료해야 할 사항

이 튜토리얼을 시작하기 전에 아래 3단계를 완료해야 합니다.

Sandbox 회원 API 자격 증명 요청
샌드박스 만들기 ORCID 계정
Google oauth 플레이그라운드 구성

이 자습서에서는 다음을 사용합니다. ORCID의 테스트 환경, ORCID 모래 상자. 샌드박스는 프로덕션과 동일하게 작동합니다. ORCID 레지스트리, 몇 가지 예외:

샌드박스는 다음으로만 이메일을 보냅니다. mailinator.com 구애
대부분의 가져오기 마법사 도구는 샌드박스에서 작동하지 않습니다.
정보 콘텐츠(정보, 연구원용, 멤버십 등)에 대한 메뉴 링크가 샌드박스에서 작동하지 않습니다.
샌드박스에는 프로덕션 데이터가 포함되어 있지 않습니다.

Sandbox 회원 API 자격 증명 요청

API 자격 증명은 다음으로 구성됩니다. 클라이언트 ID 및 비밀 구매자 인증된 ID 및/또는 사용자와 상호 작용할 수 있는 권한을 수집하는 데 필요한 ORCID 기록. 샌드박스 자격 증명을 신청하세요. here. Google OAuth Playground로 테스트 중임을 알리는 메모를 추가하세요. 이것은 수동 프로세스이며 자격 증명이 생성되는 데 최대 24시간이 걸릴 수 있습니다.

샌드박스 만들기 ORCID 계정

새 창이나 탭에서 다음을 방문하세요. https://sandbox.orcid.org/register

이름과 이메일 주소를 입력하고 "다음" 버튼을 클릭합니다. 중요한! 실제 이메일 주소를 사용하지 마십시오! 대신 @mailinator.com으로 끝나는 주소를 만드십시오.
비밀번호로 등록 양식의 2단계를 완료하고 3단계로 이동합니다.
원하는 가시성 설정을 선택하고 사용 약관에 동의한 다음 "로봇이 아닙니다" 텍스트 옆에 있는 상자를 클릭하고 마지막으로 "등록" 버튼을 클릭합니다.

이메일과 비밀번호를 기억하세요. 튜토리얼 전체에서 필요합니다!

당신의 구성 구글 OAuth 플레이그라운드

We Buy Orders 신청서를 클릭하세요. 구글 OAuth 플레이그라운드
오른쪽 상단 모서리에 있는 톱니바퀴 아이콘을 클릭하여 OAuth 2.0 구성

Oauth 끝점 드롭다운을 사용자 지정으로 변경하고 다음 설정을 입력하고 닫기를 클릭합니다.

중요한! 위 단계에서 구성한 내용을 잃지 않도록 Google OAuth Playground를 열어 둡니다. 이러한 구성으로 Playground를 초기화할 수 있는 URL을 저장할 수도 있습니다(URL을 얻으려면 오른쪽 상단 모서리에 있는 톱니바퀴 아이콘 옆에 있는 링크 아이콘 클릭).

수집 인증 ORCID ID 및 권한

ORCID 통합은 "3 legged OAuth"를 사용하여 사용자를 인증하고 레코드와 상호 작용할 수있는 권한을 요청합니다. 모든 통합은 공용 API를 사용하여 읽기 권한을 요청할 수 있습니다. ORCID 회원은 Member API를 사용하여 읽기 및 쓰기 권한을 요청할 수 있습니다.

이 섹션에서는 사용자 지정 통합이 인증을 받기 위해 완료해야 하는 단계를 안내합니다. iD 및 읽기 및 쓰기 권한 ORCID 기록

인증 받기 iD 사용자의 기록 액세스 권한에는 다음이 포함됩니다. OAuth 2.0, 인증을 위한 업계 표준 프로토콜입니다. OAuth를 사용하면 사용자가 해당 사이트에 비밀번호를 제공하지 않고도 웹사이트 또는 애플리케이션에 다른 사이트에 저장된 계정 정보에 대한 액세스 권한을 부여할 수 있습니다.

특정 사이트에 대한 자격 증명 대신 Google 또는 Facebook을 사용하여 사이트에 로그인한 적이 있다면 이미 OAuth를 사용한 것입니다!

OAuth 프로세스에는 3단계가 포함됩니다.

인증 URL 생성
인증 코드 받기
액세스 토큰에 대한 인증 코드 교환

OAuth 프로세스를 시작하려면 사용자를 ORCID 로그인 화면. 이 URL은 다음으로 구성됩니다. 권한 부여 엔드포인트뿐만 아니라 매개 변수 조직과 요청하려는 권한을 식별합니다.

활동(소속, 펀딩, 작품, 피어 리뷰, 연구 리소스) 추가/업데이트, 개인 항목(다른 이름, 키워드, 국가, 연구원-url, 웹사이트 및 개인 외부 식별자) 추가/업데이트에 대한 권한을 요청하기 위해 인증 URL은 다음과 같습니다.

https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplayground

하지만 Google OAuth 플레이그라운드를 사용하여 인증 URL을 구축할 수 있습니다.

/activities/update, /person/update, /read-limited를 범위 필드에 추가하고 API 승인을 클릭합니다.

인증 URL은 구성 및 범위 필드에 입력한 정보를 사용하여 생성되었을 것입니다.

An ORCID 로그인 화면이 나타납니다. 계정을 만들 때 사용한 이메일 주소와 비밀번호로 Sandbox 계정에 로그인합니다. ORCID 이 자습서를 시작할 때 계정을 사용합니다. 로그인하면 OAuth 화면이 나타납니다. 인증 URL에 포함된 클라이언트 이름과 관련 범위가 이 화면에 표시됩니다. 액세스 권한을 부여하려면 '액세스 권한 부여'

권한을 부여하면 Sandbox 자격 증명과 연결된 리디렉션 URI이므로 Google OAuth Playground로 다시 리디렉션됩니다. 브라우저 주소 표시줄의 리디렉션 URI 끝에 6자리 인증 코드가 표시됩니다. 2단계 구글 oauth 플레이그라운드 페이지 왼쪽 섹션)

액세스 토큰 및 인증된 ID에 대한 인증 코드 교환

인증 코드가 있으면 액세스 토큰과 인증 코드로 교환할 수 있습니다. iD 로그인한 사용자의 권한을 요청한 API 작업을 수행하는 데 필요합니다.

액세스 토큰을 분실한 경우 프로세스를 다시 완료할 수 있지만 먼저 동일한 것을 사용하는 경우 클라이언트 애플리케이션에 대한 권한을 취소해야 합니다. ORCID ID. "신뢰받는 당사자" 페이지의 "신뢰할 수 있는 조직" 섹션에서 클라이언트 애플리케이션을 제거하여 권한을 취소할 수 있습니다.

실제 상황에서 이러한 교환은 PHP, Java 또는 Ruby on Rails와 같은 프로그래밍 언어를 사용하여 시스템에서 수행됩니다. 이 자습서에서는 Google OAuth Playground를 사용하여 웹 애플리케이션을 시뮬레이션합니다.

'토큰에 대한 인증 코드 교환'

"를 클릭하면토큰 교환 인증 코드” 귀하의 액세스 토큰 및 인증 iD 에 나타납니다. 요청 / 응답 오른쪽 섹션. 아래 예를 참조하십시오.

액세스 토큰 요청에 대한 Google OAuth Playground json 응답

이 토큰을 저장하십시오!

필요한 호출을 쉽게 생성할 수 있으므로 위 단계에서 받은 토큰을 저장하는 것이 중요합니다. 전체 토큰 교환 응답을 저장하는 것이 좋습니다.

이제 인증된 항목을 수집했습니다. ID 및 사용자의 읽기 권한 ORCID 기록 및 업데이트 ORCID 기록.

쓰기 ORCID 기록(POST)

이 섹션에서는 Sandbox 레코드에 교육 기관을 추가합니다. 다음 예에서는 /education 엔드포인트를 다음과 함께 사용하고 있습니다. 올바른 XML 정보를 추가할 수 있지만 예를 들어 고용 또는 직장을 추가할 수도 있습니다. 우리의 Github 문서 더 많은 예제 파일 및 엔드포인트와 각각에 필요한 권한을 확인하십시오.

다음은 이 연습에 사용할 수 있는 교육 XML의 예입니다.

<?xml version="1.0" encoding="UTF-8"?>
<education:education
	xmlns:common="http://www.orcid.org/ns/common" xmlns:education="http://www.orcid.org/ns/education"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.orcid.org/ns/education ../education-3.0.xsd ">	
	<common:department-name>department-name</common:department-name>
	<common:role-title>role-title</common:role-title>
	<common:start-date>
		<common:year>1948</common:year>
		<common:month>02</common:month>
		<common:day>02</common:day>
	</common:start-date>
	<common:end-date>
		<common:year>1948</common:year>
		<common:month>02</common:month>
		<common:day>02</common:day>
	</common:end-date>
	<common:organization>
		<common:name>common:name</common:name>
		<common:address>
			<common:city>common:city</common:city>
			<common:region>common:region</common:region>
			<common:country>AF</common:country>
		</common:address>
		<common:disambiguated-organization>
            <common:disambiguated-organization-identifier>http://dx.doi.org/10.13039/100000001</common:disambiguated-organization-identifier>
			<common:disambiguation-source>FUNDREF</common:disambiguation-source>
        </common:disambiguated-organization>
	</common:organization>		
	<common:url>http://tempuri.org</common:url>  
	<common:external-ids>
        <common:external-id>
            <common:external-id-type>grant_number</common:external-id-type>
            <common:external-id-value>external-identifier-value</common:external-id-value>          
            <common:external-id-url>http://tempuri.org</common:external-id-url>
            <common:external-id-relationship>self</common:external-id-relationship>
        </common:external-id>
        <common:external-id>
            <common:external-id-type>grant_number</common:external-id-type>
            <common:external-id-value>external-identifier-value2</common:external-id-value>         
            <common:external-id-url>http://tempuri.org/2</common:external-id-url>
            <common:external-id-relationship>self</common:external-id-relationship>
        </common:external-id>
    </common:external-ids>
</education:education>

Google Playground의 브라우저 탭으로 돌아갑니다. 탭을 열어 두지 않은 경우 이전에 저장한 URL로 세션을 다시 초기화할 수 있습니다(표시되는 경고에서 확인 클릭). 또는 모든 관련 필드를 작성하고 아래 스크린샷과 같은지 확인하여 통화를 다시 설정할 수 있습니다.

확인 구성 당신의 클라이언트 ID 그리고 클라이언트 비밀
Google oauth 플레이그라운드 내에서 2단계 아래에 액세스 토큰 채워
여전히 이전의 토큰이 있어야 하거나 다음과 같이 이전 연습에서 채울 수 있습니다.
3단계 아래 클릭 헤더 추가, 아래 값을 입력한 다음 추가 및 닫기
- 헤더 이름: 수락
- 헤더 값: 애플리케이션/vnd.orcid+xml
3단계: API에 대한 요청 구성 아래에서 HTTP 메서드를 POST로 설정합니다.
. URI 요청 필드 입력:
https://api.sandbox.orcid.org/v3.0/[ORCID ID]/education
바꾸다 [ORCID 아이디]와 iD Sandbox 레코드의 경우 상호 작용 권한을 수집한 XXXX-XXXX-XXXX-XXXX 형식입니다.
컨텐츠 타입 > 관습 그리고 application/vnd를 입력합니다.orcid+xml 클릭 추가다음을 클릭합니다 닫기.
요청 본문 입력.

이 섹션 상단의 교육 제휴 XML을 복사하여 요청 본문 텍스트 상자
새로운 교육 제휴를 위한 Google OAuth Playground 요청 본문 구성

선택 과목: . 요청 본문 텍스트 상자에서 기관을 반영하도록 XML을 편집합니다.
을 위한 , 사용 ROR 레지스트리 ROR을 찾기 위해 ID 당신의 기관을 위해n.

닫기.

요청 보내기.

결과는 요청 / 응답 오른쪽 섹션. 아래로 스크롤하십시오 – 보이는 경우 HTTP/1.1 201 생성됨, 귀하의 교육 기관이 성공적으로 추가되었습니다!
성공적인 교육 제휴 POST 요청에 대한 Google OAuth Playground 응답

또한 다음 섹션에 필요할 풋 코드를 저장하십시오!

https://sandbox에서 Sandbox 레코드의 공개 보기를 방문하십시오.orcid.org/[ORCID ID] 귀하의 새로운 교육 기관을 확인하십시오.

Source는 제휴를 추가한 API 클라이언트의 이름을 보여줍니다. 이것은 다른 시스템이 사용하는 데 도움이 되는 핵심 요소입니다. ORCID 데이터는 이 정보가 신뢰할 수 있는지 여부를 결정합니다.

업데이트 ORCID 기록(PUT)

실제 상황에서는 연구원의 소속을 업데이트해야 할 수 있습니다. 이 섹션에서는 종료 날짜를 포함하도록 교육 제휴를 업데이트합니다.

Put 코드는 특정 항목을 참조하는 짧은 숫자 코드입니다. ORCID 기록. API 호출과 함께 넣기 코드를 사용하여 특정 항목을 업데이트, 삭제 또는 읽습니다(항목 요약과 반대).

의 각 항목 ORCID iD 고유하게 식별하는 넣기 코드가 할당됩니다. 전체 레코드 또는 섹션을 읽을 때 항목의 속성으로 넣기 코드를 찾을 수 있습니다. 언제 레코드의 특정 항목 호출, 넣기 코드는 항목을 식별하는 데 사용됩니다. Put 코드는 참조하는 항목 유형 내에서 고유합니다. 이 예제를 사용하면 ORCID 레지스트리는 풋 코드 733535를 가지지 만 733535는 자금 조달 항목이나 키워드에 대한 풋 코드로도 사용될 수 있습니다.

연구원의 기록에 항목을 게시하면 API 응답에 해당 항목에 대한 넣기 코드가 포함됩니다. 해당 항목을 읽거나 업데이트하거나 삭제해야 하는 경우 나중에 사용할 수 있도록 넣기 코드를 저장할 수 있습니다.

가지고 있지 않은 특정 항목에 대한 풋 코드를 찾으려면 해당 항목이 있는 섹션의 레코드 또는 요약을 읽어야 합니다. 수정하려는 항목에 대한 넣기 코드가 응답으로 반환됩니다.

아래 예에서는 단일 교육 항목을 업데이트하고 있습니다.

참고: 소속 교육 기관에 대한 코드를 저장한 경우 아래 4단계로 건너뛸 수 있습니다. 넣기 코드를 저장하지 않은 경우 아래 1단계부터 시작하세요.

먼저 우리는 얻을 필요가 코드 입력 방금 추가한 교육 제휴에 대해 새 Google Playground 창을 열고 시작하기 섹션의 처음 4단계에 따라 설정하세요.
이번에는 요청 URI 필드에 https://api.sandbox를 입력합니다.orcid.org/v3.0/0000-XXXX-XXXX-XXXX/educations . URI 끝에 /educations를 추가했으며 복수라는 점에 유의하십시오. 이것은 하나가 아니라 이 레코드에 있는 모든 교육 항목의 요약을 가져오고 있음을 의미합니다(단수를 지정하고 끝에 항목의 /put-code를 추가함).
'요청 보내기'를 누르면 아래 이미지와 같은 내용이 표시됩니다. 요청 / 응답 부분. 찾기 코드 이전 섹션에서 추가한 소속 교육 기관(여기에 강조 표시된 번호와 다른 번호).
변화 HTTP 메소드 에 PUT
헤더 추가 Accept 및 Content-type이 모두 application/vnd로 설정되어 있는지 확인하십시오.orcid+xml
. URI 요청 필드 입력:
https://api.sandbox.orcid.org/v3.0/[ORCID ID]/education/[PUT CODE]
바꾸다 [ORCID 아이디]와 iD 샌드박스 레코드의 경우 교육 기관에 대한 풋 코드로 XXXX-XXXX-XXXX-XXXX 및 [PUT CODE] 형식을 지정합니다.
POST 섹션에서 XML을 다시 가져오고 클릭하십시오. 요청 본문 입력 그리고 붙여 넣습니다.
교육 제휴 종료일 수정
닫기.
요청 보내기를 클릭합니다.
결과는 요청 / 응답 오른쪽 섹션. 아래로 스크롤하십시오 – 보이는 경우 HTTP / 1.1 200 OK, 귀하의 교육 기관이 성공적으로 업데이트되었습니다! 오류 메시지가 표시되면 헤더 값이 헤더 추가 깨진 텍스트로 변경되지 않았습니다(예: application%2Fvnd).orcid%2Bxml”
를 방문 대중의 시선 https://sandbox에서 샌드박스 레코드의orcid.org/[ORCID ID] 새 종료 날짜가 채워진 업데이트된 교육 제휴를 확인합니다.

독서 ORCID 기록(GET)

확인 구성 당신의 클라이언트 ID 그리고 클라이언트 비밀
2단계 액세스 토큰 채워
여전히 이전의 토큰이 있어야 하거나 다음과 같이 이전 연습에서 채울 수 있습니다.
3단계 클릭 헤더 추가, 아래 값을 입력한 다음 추가 및 닫기
- 헤더 이름: 수락
- 헤더 값: 애플리케이션/vnd.orcid+xml
3단계 구성은 아래 스크린샷과 같아야 합니다.
HTTP 메소드를 다음으로 설정하십시오. 바로.
요청 URI 필드에 다음을 입력하십시오.
https://api.sandbox.orcid.org/v3.0/0000-XXXX-XXXX-XXXX/record
바꾸다 [ORCID 아이디]와 iD Sandbox 레코드의 경우 XXXX-XXXX-XXXX-XXXX 형식

참고 : 엔드 포인트 URI 끝에 있는 단어입니다. 이 경우 우리는 읽고 있습니다 개요 위와 같이 /record로 URL을 끝냅니다.
요청 보내기
요청/응답 필드에 전체 레코드의 XML 요약이 표시되어야 합니다. 응답의 첫 번째 부분을 보여주는 아래 예와 약간 비슷합니다. 이전 섹션에서 논의한 것처럼 넣기 코드를 강조 표시했습니다.