ORCID 한 번에 2 개의 주요 API 버전을 지원하는 것을 목표로합니다. 새로운 주요 API 버전이 출시되면 ORCID 출시일로부터 최소 12 년 동안 지원을 보장합니다. 또한 가장 오래된 메이저 버전을 폐기하기 XNUMX 개월 전에 통지하고, 통지 기간 동안 여전히 사용중인 회원에게 주기적으로 알림 이메일을 보냅니다. 메타 데이터 스키마를 획기적으로 변경할 때마다 새로운 주 버전이 필요하며 주 버전 번호의 증가로 표시됩니다. ORCID 2 ~ 4 년마다 새로운 주요 API 버전을 출시합니다.
예외적 인 상황에서 ORCID 새로운 주요 API 버전이 출시되면 12 개월의 사용 중지 기간을 연장 할 수 있습니다. ORCID 유지 보수 작업에 추가 리소스를 투자하고 새로운 개발 및 지원과 같은 다른 활동에 결과적으로 영향을 미칩니다. ORCID 는 발생하는 추가 비용을 상쇄하기 위해 사용 중지 날짜 이후에도 사용 중지 된 API 버전을 계속 사용하는 경우 추가 비용을 청구 할 권리가 있습니다.
ORCID API 제공을 발전시키고 주요 릴리스 간의 커뮤니티 요구에 대응할 수있는 점진적 API 지원 중단 정책이 있습니다. 이것은 ORCID 현재 API 버전의 제어 된 어휘 및 메타 데이터 필드를 중단하지 않고 변경할 수 있습니다.
- 최신 API 버전 사용자는 이러한 변경 사항을 무시할 수 있지만 변경 될 수 있음을 알고 있어야합니다.
- 이전 API 버전 사용자는 해당 버전에서 모델링 할 수없는 데이터를받지 못합니다.
작성 당시의 예는 v3.0 API에 CREDIT 기여자 역할 분류를 도입 한 것입니다. 활성화되면 v2.x 통합은 점점 더 많은 연구자와 통합이 CREDIT을 채택함에 따라 기여자 역할의 가시성을 서서히 잃게됩니다. V2.x 사용자는 중단되지 않지만 시간이 지남에 따라 덜 풍부한 메타 데이터를 받게됩니다.
새로운 주요 API 버전을 개발할 때 ORCID '출시 후보'버전을 생성합니다. 이는 정식 버전의 API가 출시되면 적시에 업그레이드 할 수있는 통합 업체를 대상으로합니다. 출시 후보의 예상 수명은 개발 대상인 주 버전 출시로부터 최대 12 개월입니다.
우리는 통합 자에게 견고성 원리 (일명 Postel의 법칙) ORCID API.
배경
ORCID 겸손한 시작에서 API를 천천히 발전 시켰습니다.
API v1.x (레지스트리와 함께 출시 ~ 2012)는 연구원 및 연구 활동에 대한 모든 메타 데이터를 단일 API 응답으로 반환하려고했습니다. 통합자는 새 항목을 추가하거나 기존 항목을 업데이트하기 위해이 메타 데이터를 수정하고 전체를 다시 보내야했습니다. 이것은 합리적인 첫 번째 시도 였지만 확장하지 않았고 추가 및 업데이트하는 것은 힘든 작업이었습니다. (2018 년 XNUMX 월 은퇴)
API 2.x (2017 년 XNUMX 월 출시)는 API를 섹션으로 분할했습니다. 작품, 제휴, 자금 지원, 전기 등. 그것은 큰 진전이었고 우리 자신과 우리 고객 모두 큰 기록을 훨씬 쉽게 관리 할 수있게했습니다. 그러나 검증 및 제어 된 어휘의 대부분이 스키마에 하드 코딩되어 변경에 대응하기가 어려웠습니다.
API 3.x (2019 년 XNUMX 월 출시)는 연구 리소스와 같은 새로운 섹션을 레코드에 추가하고 스키마 구조를 단순화하고 제공했습니다. ORCID 추가적인 유연성으로. 스키마에서 서버로 유효성 검사의 대부분을 이동하여 API의 추가 버전을 출시하지 않고도 문제를 해결하고 새로운 식별자 유형을 추가 할 수있었습니다.
새로운 주요 API를 출시하는 것은 엄청난 작업입니다. API를 생성하려면 수년 간의 개발자 노력이 필요하며 통합을 업그레이드하려면 회원이 몇 년 더 노력해야합니다. 이러한 이유로 우리는 변경 사항을 제한하려고합니다. 그러나 커뮤니티에 가장 잘 봉사하기 위해 몇 가지 변경하고 싶은 사항이 있습니다.
우리의 임무는 API의 새 버전을 출시 할 임계 값이있을 때 해결하거나 기존 통합을 중단하지 않고 기존 API를 업데이트하는 방법을 찾는 것입니다.