API 자습서 : 레코드에서 데이터 읽기

개발자가 공용 API를 테스트하는 것이 좋습니다. 샌드 박스 테스트 서버 프로덕션 버전을 사용하기 전에. 다음은 샌드박스 및 프로덕션 환경 모두에서 공개 API 자격 증명을 등록하는 방법에 대한 단계입니다.

• 에 로그인하여 ORCID 기록:
  프로덕션 서버 : https://orcid.org/signin
  샌드 박스 테스트 서버 : https://sandbox.orcid.org/signin
• 오른쪽 상단에있는 이름을 클릭하세요.
•  개발자 도구 메뉴 옵션에서
  참고 : 개발자 도구에 액세스하려면 이메일 주소를 확인해야 합니다. 이메일 주소를 아직 확인하지 않은 경우 공개 API 자격 증명을 등록하기 전에 이메일 주소를 확인하라는 메시지가 표시됩니다.
• '를 읽고 동의합니다.ORCID 공용 클라이언트 서비스 약관
• "등록하기"를 클릭합니다. ORCID 공개 API 자격 증명” 버튼을 누릅니다.

신청서 세부 정보 양식 작성

• 공개 API 자격 증명에 등록하면 개발자 도구(https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• 새로운 신청서를 등록하려면 제시된 신청서 세부 정보 양식을 작성해야 합니다.
  • 성함: 애플리케이션의 이름입니다. 이 정보는 사용자가 애플리케이션을받을 수있는 권한을 부여 할 때 표시됩니다. ORCID iD에 표시되며 신뢰할 수있는 조직 목록. 조직 또는 서비스의 이름 (예 : 저널 이름)을 사용하는 것이 좋습니다.
  • 신청 URL: 사용자가 애플리케이션에 대해 자세히 알아보기 위해 방문할 수 있는 웹 사이트입니다. 이것은 또한 그들의 신뢰할 수있는 조직 목록.
  • 응용 프로그램 설명: 개발중인 애플리케이션에 대한 정보와 사용자의 ORCID 신분증. OAuth 화면에서 사용자에게 표시됩니다.

첨가 리디렉션 URI

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

• 제공된 상자에 리디렉션 URI를 입력합니다.
• 1개 이상의 리디렉션 URI를 입력해야 하는 경우 '다른 리디렉션 URI 추가'를 클릭하십시오.

참고 사항 :

• 만 HTTPS URI 생산에 허용됩니다
• 등록된 도메인 MUST 하위 도메인을 포함하여 사용된 도메인과 정확히 일치
• 가능한 경우 모든 리디렉션 URI를 완전히 등록합니다. 이것은 가장 안전한 옵션이며 우리가 권장하는 것입니다. 리디렉션 URI에 대한 자세한 내용은 다음을 참조하세요. 리디렉션 URI FAQ

애플리케이션 저장

신청서를 작성하고 리디렉션 URI를 추가하면 신청서를 저장할 수 있습니다.

• '내 애플리케이션을 저장하고 클라이언트 ID와 비밀번호를 생성하세요'를 클릭하세요.

이제 공개 API 클라이언트 자격 증명이 포함된 개발자 도구 페이지로 다시 이동됩니다.

자격 증명 업데이트

신청서 정보를 변경하는 것은 매우 간단합니다.

• 해당 정보 수정 후 '지원서 저장' 클릭

자격 증명 사용

이제 자격 증명을 얻었으므로 ORCID 공개 API!

귀하가 회원이 되시면 귀하의 자격 증명을 회원 API로 이전할 수 있습니다. ORCID 회원 에서 귀하를 참조하는 데 사용됩니다.

여러분의 시간과 재능으로 샌드 박스 멤버 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. 이러한 주소를 사용하기 전에이 서비스의 작동 방식과 제한 사항을 검토하는 것이 좋습니다.

공개 또는 멤버 API 자격 증명이있는 사람은 누구나 / 공개 읽기 액세스 토큰. 토큰을 얻으려면 다음을 호출합니다. ORCID API 토큰 엔드 포인트.

이 프로세스를 종종 클라이언트 자격 증명 OAuth 흐름 또는 2 단계 OAuth라고합니다.

샌드 박스에서 공개 데이터를 읽기위한 액세스 토큰을 얻는 예제 호출 — 자리 표시자를 자격 증명으로 바꿉니다 (대괄호를 제거해야합니다.

URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  METHOD: POST
  DATA: 
    client_id=[Your public API client ID]
    client_secret=[Your public API secret]
    grant_type=client_credentials
    scope=/read-public

그러면 다음과 유사한 액세스 토큰이 반환됩니다. 반환된 토큰은 오래 지속되며(약 20년 동안 만료되지 않음) 공개 데이터를 검색하는 데 여러 번 사용할 수 있습니다. ORCID 기록. 

{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}

참고 : / authenticate 범위가있는 모든 토큰에는 이제 / read-public 범위도 포함됩니다. / authenticate 범위 만 사용하는 경우 저장된 액세스 토큰을 사용하여 액세스 토큰을 다시 얻을 필요없이 공용 데이터를 읽을 수 있습니다. 

회원 API를 사용하는 통합자는 / 공개 읽기 읽을 수 있는 범위 ORCID 기록 요약.

/read-limited 액세스 권한을 얻으려면 연구원에게 권한을 요청해야 합니다. OAuth를 사용하여 이 작업을 수행합니다. 구체적으로, "3 개의 다리가있는 OAuth".

자세한 내용은 API 자습서 : 데이터 읽기 ORCID 기록

ORCID 통합은 "3 legged OAuth"를 사용하여 사용자를 인증하고 레코드와 상호 작용할 수 있는 권한을 요청합니다. 모든 통합은 공개 API를 사용하여 읽기 권한을 요청할 수 있습니다. ORCID 회원은 회원 API를 사용하여 업데이트 권한을 요청할 수 있습니다. 다음과 같이 작동합니다.

• 특별한 링크를 만듭니다.
• 클릭하면 사용자가 ORCID
  • ORCID 사용자에게 로그인을 요청합니다.
  • ORCID 사용자에게 애플리케이션에 대한 권한 부여를 요청합니다.
  • ORCID 사용자를 인증 코드와 함께 시스템으로 다시 보냅니다.
• 시스템은 해당 코드를 액세스 토큰으로 교환합니다.

사용자 정의된 승인 URL에는 귀하의 클라이언트 정보뿐만 아니라 귀하가 액세스하려는 기록의 특정 영역을 지정하는 '범위'도 포함됩니다. 로그인한 후 사용자는 시스템 연결을 승인하고 인증 코드와 함께 랜딩 페이지로 돌아갑니다. 그런 다음 이 코드를 사용하여 ORCID iD 요청된 범위에 유효한 액세스 토큰과 함께.

인증 링크를 만들고 인증 코드를 가져옵니다.

API 자격 증명의 클라이언트 ID와 관련 랜딩 페이지(리디렉션 URI)를 지정하여 권한 부여 링크를 빌드합니다. 요청할 권한을 설정하여 선택합니다. 범위 매개 변수.

아래 예제는 액세스가 제한된 데이터를 읽을 수있는 권한을 요청합니다. ORCID 샌드박스 테스트 서버. 실제로는 이 링크를 웹사이트에 표시하거나 사용자에게 인증 및 권한 부여를 요청할 때 이메일에 포함시킵니다. 그러나 테스트 목적으로 간단히 웹 브라우저에 붙여넣을 수 있습니다. 괄호 안의 데이터를 고객 정보로 바꾸고 대괄호를 제거하세요!

https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]

사용자가 링크를 클릭하고 로그인 한 경우 ORCID 부여 된 권한은 다음과 같이 사이트로 다시 리디렉션됩니다.

https://[Your landing page]?code=Q70Y3A

승인 코드를 ORCID iD 및 액세스 토큰

즉시 승인 코드를 교환해야합니다. ORCID iD 및 액세스 토큰. 인증 코드는 사용 시 만료됩니다. 요청은 다음과 같습니다. 웹 브라우저에서 만들 수 없습니다, 서버에서 만들어야합니다.

 URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  HEADER: Content-Type: application/x-www-form-urlencoded
  METHOD: POST
  DATA: 
    client_id=[Your client ID]
    client_secret=[Your client secret]
    grant_type=authorization_code
    code=Six-digit code
    redirect_uri=[Your landing page]

ORCID 그런 다음 연구원의 인증을 반환합니다 ORCID iD JSON 형식의 액세스 토큰:

{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}

액세스 토큰은 기본적으로 오래 사용되며 발행 후 20 년이 지나면 만료됩니다. 토큰은 만료되기 전에 여러 번 사용할 수 있습니다.

액세스 토큰 사용

3-legged 액세스 토큰은 특정 ORCID 기록. 이를 사용하려면 해당 레코드를 읽거나 업데이트하기 위해 수행하는 API 요청에 이를 포함시킵니다.

가시성은 사용자가 설정 한 가시성 기본 설정에 따라 항목의 개인 정보 설정을 나타냅니다. API를 통해 정보를 게시 할 때 가시성 태그가 포함되면 무시됩니다. 오히려 정보는 계정 환경 설정에 설정된 사용자의 기본 공개 환경 설정에 따라 게시됩니다.

공개 항목은 API를 통해 누구나 읽을 수 있으며 연구원의 공개 기록에 표시됩니다. 신뢰할 수 있는 당사자 항목은 API를 통해 읽기 제한 액세스 권한이 있는 클라이언트에게만 반환됩니다. 연구자의 공개 기록에는 없습니다. 개인 항목은 연구원과 항목 소스만 볼 수 있습니다. API를 통해 반환되는 유일한 개인 항목은 통합을 통해 기록에 추가된 항목입니다. 가시성 설정에 대한 자세한 내용은 ORCID 레지스트리.

이 예제 호출은 전체 ORCID 샌드 박스 서버에서 멤버 API를 사용하여 XML 형식으로 기록합니다. Public 또는 Member API에 API 요청을하려면 액세스 토큰이 필요합니다.

Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token: 
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record

API는 요청이 성공적으로 수신되었음을 나타내는 200 OK 메시지를 반환하고 ORCID 개별 항목의 요약을 포함하여 기록합니다.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
     <funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
  [...] 
  </record:record>

각 항목 (일, 자금, 고용 등)에는 코드 입력. 필요한 경우 항목의 전체 세부 정보를 얻는 데 사용할 수 있습니다.

이 어플리케이션에는 XNUMXµm 및 XNUMXµm 파장에서 최대 XNUMXW의 평균 출력을 제공하는 ORCID 레코드를보다 빠르고 일관성있게 읽을 수 있도록 개별 섹션으로 나뉩니다. 먼저 섹션을 호출하여 요약을받은 다음 개별 항목의 넣기 코드를 사용하여 해당 항목에 대한 강력한 정보를 수신 할 수 있습니다.

API를 사용하여 읽을 수있는 요약 섹션 표가 아래에 나와 있습니다.

모든 항목(전기 텍스트 제외)은 ORCID 기록은 코드 입력:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>      
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">   [...] 
</record:record>

이 풋 코드는 항목에 대한 전체 데이터를 검색하기 위해 API를 호출하는 데 사용할 수 있습니다. 다음 항목은 a를 사용하여 쿼리 할 수 ​​있습니다. 코드 입력:

섹션 엔드 포인트 및 코드 입력을 사용하면 동일한 액세스 토큰을 사용하여 API를 호출하여 해당 특정 항목을 완전히 가져올 수 있습니다. 이 예제 호출은 샌드 박스 서버에서 멤버 API를 사용하여 XML 형식의 전체 자금 조달 항목 4413을 검색합니다.

Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413

예제 호출 : GitHub

API는 메시지가 성공적으로 수신되었음을 나타내는 200 OK 메시지를 반환하고 자금 조달 항목의 전체 XML을 반환합니다.

<?xml version="1.0"  encoding="UTF-8" standalone="yes"?>
    <funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public"  [...] >
    [...] 
    </funding:funding>

당신은을 확인할 수 있습니다 항목의 출처 누가 그것을 추가했는지 알고 싶다면 그것을 읽을 때.

작동 ORCID 식별자와 저작물과의 관계에 따라 함께 그룹화됩니다. 다음과 같은 네 가지 유형의 관계가 있습니다.

• 셀프: 식별자는 해당 저작물만을 지칭하며 동일한 식별자를 가진 다른 저작물과 그룹화 될 수 있습니다.
• 부분의: 저작물은이 식별자의 일부이며 다른 저작물과 그룹화 할 수 없습니다.
• 버전: 이러한 식별자는 작업의 대체 버전에 적용되며 자체 및 식별자 버전으로 그룹화 될 수 있습니다.
• 재정 지원:이 식별자는 작업 자금에 적용됩니다. 이러한 식별자는 작품을 분류하는 데 사용되지 않습니다.

우리 API는 XSD에서 이를 지원합니다. 각 항목에는 그룹 내 순위를 나타내는 표시 색인 속성이 있습니다. 가장 높은 표시 지수가 연구자가 선택한 선호 항목입니다. 연구원이 순위를 지정하지 않은 API를 통해 추가된 항목은 표시 지수 1을 가지며 연구원이 변경할 때까지 그룹 내 기본 선호 소스로 사용됩니다. 디스플레이 인덱스는 또한 읽을 때 작업 순서를 결정합니다. ORCID API로 기록하세요.

그룹화에 대한 자세한 내용은 ORCID 기록, 우리의 지원 기사.

이 어플리케이션에는 XNUMXµm 및 XNUMXµm 파장에서 최대 XNUMXW의 평균 출력을 제공하는 ORCID 레지스트리는 "콘텐츠 협상"을 지원합니다. 이것은 기계와 다른 시스템이 다음을 요청할 수 있음을 의미합니다. ORCID 다른 형식의 개인 메타 데이터에 대한 레지스트리.

이러한 형식 중 하나는 JSON-LD입니다. schema.org 특히 어휘 개인 유형, 우리는 저작물, 조직 및 기타 식별자와 연결합니다. 또한 XML, JSON, RDF XML 및 거북이를 지원하고 데이터에 쉽게 액세스할 수 있도록 CORS(Cross-Origin Resource Sharing)를 구현했습니다.

• 이 참조 개요에 대한 블로그 게시물 ORCID 및 schema.org
• 우리를 참조하십시오 콘텐츠 협상에 대한 기술 문서

다음과 같이 cURL을 사용하여 사용자 검색:

curl -iL https://orcid.org/0000-0000-0000-0000

사용자가 200을 반환하더라도 하지 않습니다 존재하다. 이를 피하려면 다음과 같이 호출에서 콘텐츠 협상을 사용하십시오.

curl -iL -H 'Accept: application/xml' https://orcid.org/0000-0000-0000-0000