このAPIは、GBIF登録に関するものであり、登録が行われたデータセット、インストレーション、団体・機関、ノードおよびネットワークの検索が可能です。

プログラム内ではJavaウェブサービスクライエントを用いて、HTTPベースのREST対応ウェブサービスを提供しています。APIのコードを書く人の中には、関心のある方もいると思われます。registry-ws-clientプロジェクトのページに詳細があります。

旧版の登録APIに対するサポートも継続しているものの、現在では奨励していません。新たに使用を開始する方には、新版のAPIを推奨しています。

・各機能メニュー

データセット  データセット検索  データセット・メトリクス（指標）  インストレーション（データセットのインストール場所）  機関  ノード  ネットワーク  クエリ・パラメータの解説  OAI-PMH

データセット

データセットAPIにより、データセットの作成、読み出し、更新および削除（以下、「CRUD」と呼びます。）並びに検索を行うことができます。 GBIFポータルにおいて最も重要な使い方は、データセットの検索およびデータセット・ページの設定を行うことです。

データセットの削除は、論理削除により行います。すなわち、一度登録したエントリーは、そのまま残りますが、 削除タイムスタンプが記録されます。一方、データセットの連絡先、エンドポイント、識別子、タグ、マシンタグ、 コメントおよびメタデータの説明に関しては、物理削除を行います。すなわち、エントリーは完全に削除されます。

データセット検索

データセット検索APIにより、データセットの検索ができます。

データセット・メトリクス（指標）

データセット・メトリクスAPIは、CHECKLIST形式のデータセットに関して、メトリクスを表示します。

インストレーション（データセットのインストール場所）

インストレーションAPIにより、インストレーションのCRUDおよび検索を行うことができます。

インストレーションの削除は、論理削除により行います。すなわち、一度登録したエントリーは、 そのまま残りますが、削除タイムスタンプが記録されます。一方、インストレーションに係る連絡先、 エンドポイント、識別子、タグ、マシンタグおよびコメントに関しては、物理削除を行います。 すなわち、エントリーは完全に削除されます。

機関

機関APIにより、機関のCRUDおよび検索を行うことができます。 GBIFポータルにおいて最も重要な使い方は、データ公開機関の検索を行うことです。

機関の削除は、論理削除により行います。 すなわち、一度登録したエントリーは、そのまま残りますが、削除タイムスタンプが記録されます。 一方、機関に係る連絡先、エンドポイント、識別子、タグ、マシンタグおよびコメントに関しては、物理削除を行います。 すなわち、エントリーは完全に削除されます。

ノード

ノードAPIにより、ノードのCRUDおよび検索を行うことができます。GBIFポータルにおいて最も重要な使い方は、国別ページを充実することです。

ノードの削除は、論理削除により行います。すなわち、一度登録したエントリーは、そのまま残りますが、削除タイムスタンプが記録されます。一方、ノードに係る連絡先、エンドポイント、識別子、タグ、マシンタグおよびコメントに関しては、物理削除を行います。すなわち、エントリーは完全に削除されます。

ネットワーク

ネットワークAPIにより、ネットワークのCRUDおよび検索を行うことができます。 ネットワークの削除は、論理削除により行います。すなわち、一度登録したエントリーは、 そのまま残りますが、削除タイムスタンプが記録されます。一方、ネットワークに係る連絡先、 エンドポイント、識別子、タグ、マシンタグおよびコメントに関しては、物理削除を行います。 すなわち、エントリーは完全に削除されます。

クエリ・パラメータの解説

上記の登録APIには、以下のパラメータを使うことができます。

OAI-PMH

REST対応JSON形式APIの他に、OAI-PMHを用いてデータセットの検索が可能です。 二種類のメタデータ形式、EML（生態学メタデータ言語）およびOAIダブリンコアを用いて検索ができます。 データセットは、タイプ、国およびインストレーションに基づいて、セットにグループ分けされています。

エンドポイントは、https://api.gbif.org/v1/oai-pmh/registryです。

クエリの例：

• OAI-PMHサービスに関する情報を検索する場合。
  https://api.gbif.org/v1/oai-pmh/registry?verb=Identify.
• 利用可能なセット（データセットタイプ、国および配信インストレーション）のリストを検索する場合。
  https://api.gbif.org/v1/oai-pmh/registry?verb=ListSets.
  セットには、dataset_type:CHECKLISTやcountry:NLなどの名前があります。
• 特定のインストレーションから全データセットの識別子を検索する場合。
  https://api.gbif.org/v1/oai-pmh/registry?verb=ListIdentifiers&set=installation:804b8dd0-07ac-4a30-bf92-3c1d862faf5e&metadataPrefix=eml.
  OAI-PMHプロトコールでは、oai_dcおよびemlの両形式とも全データセットでサポートされていますが、metadataPrefixは、どちらかの形式に設定しなければなりません。
• ある国にあるインストレーションから全データセットのメタデータを検索する場合。
  https://api.gbif.org/v1/oai-pmh/registry?verb=ListRecords&set=country:NL&metadataPrefix=oai_dc.
  国コードは、ISO 3166-1規格に基づいています。
• クエリによっては、結果が1ページを超える場合があります。その場合、XMLの最後には、例えば次のような再開トークン（resumptionToken）が表示されます。
  MToxMDB8Mjpjb3VudHJ5Ok5MfDM6fDQ6fDU6b2FpX2Rj
  次ページを表示する場合は、次のように行います。
  https://api.gbif.org/v1/oai-pmh/registry?verb=ListRecords&resumptionToken=MToxMDB8Mjpjb3VudHJ5Ok5MfDM6fDQ6fDU6b2FpX2Rj.
  プロトコールの詳細は、The Open Archives Initiative Protocol for Metadata Harvesting、特に4. Protocol Requests and Responsesにあります。