Java API clients

Webservice clients for the Java programming language.

GBIF’s API is implemented as a set of Java webservices. Most of the webservices include a Java client. These clients are used internally by other webservices, and in integration tests.

They implement the GBIF API library (JavaDoc), which provides model objects, enumerations and interface definitions for the public API.

Internally the modules use OpenFeign and Spring Cloud OpenFeign.

Common classes and configuration for clients can be found in the project gbif-common-ws.

Installation

Maven artefacts are available in our Maven repository:

<repository>
  <id>gbif-releases</id>
  <url>https://repository.gbif.org/content/repositories/releases</url>
</repository>

<!-- Example: Registry API -->
<dependency>
  <artifactId>registry-ws-client</artifactId>
  <groupId>org.gbif.registry</groupId>
  <version>3.96.22</version>
</dependency>

Clients

Refer to the webservice repositories for the clients and examples.

Registry
Occurrence (Occurrence search and downloads)
Checklistbank (Species and taxa)
Crawler (Dataset indexing metadata and state)
Geocode (Reverse geocoding)
Metrics (Occurrence statistics)
Vocabulary
Validator (Dataset validator)
Maps (Occurrence maps; no Java client)
Literature (Literature and citations; no Java client)

Also note that functionality is divided between these webservices in a different way to the sections of the API Reference documentation. For example, creation and retrieval of a download is implemented in the Occurrence module, but handling of download metadata is implemented in the Registry module.