よく聞かれる方法 ORCID レジストリを継続的に更新して新しい機能を追加することができますが、それでも、が所有および運用する多くのエンタープライズレベルのシステムをサポートします。 ORCID 当社の API を使用するメンバー組織。 肝心な答えは柔軟性です。 しかし、もちろん、それよりももう少し複雑です。
少しの歴史
2012 年 1.0.1 月に初めてリリースしたときは、API バージョン 1.0 から開始しました。 (私たちの以前のプロトタイプはバージョン XNUMX でした。) ご想像のとおり、最初の XNUMX 年で私たちは多くの機能拡張を行い、資金提供や提携を組織に結び付ける機能などの重要な新機能を追加しました。 ORCID 記録。 これらの各改善点について、下位互換性を維持し、組織が自由に更新できるようにしました。 23 年後 (そして 23 回の更新!)、私たちは API の 1.0.7 バージョンを積極的にサポートしていることがわかりました。 これには、管理に相当なスタッフ リソースが必要であり、メンバーやユーザーが求める機能や改善を追加する時間が減ることを意味していました。 さらに悪いことに、ほぼすべての API ユーザーがバージョン XNUMX 以前を使用していました。これは、彼らが私たちが実装およびサポートしている新機能の恩恵を受けていなかったことを意味します。 明らかに、このプロセスは誰にとってもうまく機能しませんでした。
アプローチの焦点を絞る
2013 年 XNUMX 月に、私たちは次の目標を持ったアプローチを開発しました。
- 同時にサポートされる API の数を、小規模なチームが管理できるレベルに抑えます。
- API のメジャー アップデートとマイナー アップデートについて API ユーザーに適切な情報を提供します。
- 最新のアップデートと機能へのアクセスを希望する API ユーザーや、長期にわたるエンタープライズ向けの安定した API を必要とする API ユーザーにサービスを提供します。
- 新しいバージョンに積極的に移行している API ユーザーの柔軟性を実現しますが、移行には追加のサポートや時間が必要です。
エンタープライズ向けに安定した API
現在、新しいエンタープライズ向けの安定した API バージョンを年に XNUMX 回、通常は XNUMX 月にリリースしています。 このバージョンには、前年からのすべての新機能、更新、改善が含まれています。
- 以前のエンタープライズ向け安定バージョンは引き続き機能しますが、「非推奨」とみなされます。
- API ユーザーには、廃止日の 3 ~ 6 か月前に XNUMX つのバージョンの違いが通知され、システムを更新するためのドキュメントとサポートが提供されます。 また、メンバー API との統合を構築した技術担当者にも通知を提供します。
- 一定期間が経過すると、古いバージョンは「廃止」され、その後は積極的にサポートされなくなります。 最終的には古いバージョンは動作しなくなります。
- 両方のバージョンがアクティブにサポートされる期間は、変更の範囲と更新に必要な労力によって異なります。
- 私たちは会員に対して全力で取り組んでいます。 非推奨の API バージョンのサポートを中止する前に、新しいバージョンに正常に移行したことを常に確認します。
イノベーションAPI
新機能や改善点への早期アクセスを希望するメンバーのために、最新のイノベーションを含むリリース候補 API をより頻繁に提供します。
- これらのバージョンは、次のエンタープライズ安定版リリースに含まれる可能性のある更新の早期ビューを提供します。
- これらには、私たちがテスト中の機能が含まれており、API ユーザーが新しい機能をより早く試せるようになります。
- リリース候補は通常サポートされておらず、ドキュメントも限られています。 の ORCID 開発チームは、リリース候補を使用してメンバーと協力して暫定機能を改善することに非常に興味を持っています。
現在のバージョン、変更が行われる日付などの詳細については、 バージョンドキュメント。 また、API を使用する人は誰でも、 APIユーザーグループ API に関する最新情報を共有します。