gcat/docs/index.rst

Welcome to gCat documentation!

gCat is a RESTful application which exposes operations ...

See the available REST-API on its API docs.

Base URL

In the production environment, its current value is https://api.d4science.org/gcat

Authorization

D4Science adopts state-of-the-art industry standards for authentication and authorization. Specifically, the implementation fully adopts OIDC (OpenID Connect) for authentication and UMA 2 (User Managed Authorization) for authorization flows. JSON Web Token (JWT) Access token are used for both authentication and authorization.

Obtain your Bearer token here: https://dev.d4science.org/how-to-access-resources

Java Client

The methods of the Web Service can be called by writing your own REST client application or by using already existing REST client plugins. We provide the following Java Client out-of-the-box.

Tip

If you're coding in Java it is recommended that you use this Java Client.

Maven Coordinates

<groupId>org.gcube.data-catalogue</groupId>
<artifactId>gcat-client</artifactId>
<version>[2.2.0, 3.0.0-SNAPSHOT)</version>

Methods Result

The service exposes its methods using a standard naming approach. Moreover, they accept (in case of http POST/PUT methods) JSON objects.

Important

The result of all methods is always a JSON object as per below:

{
   ....
}

Inputs are automatically validated before the request is served.

Usage examples

• Example 1

import org.gcube.gcat.client.Item;

// count item number
Item item = new Item();
int count = item.count();
...