Difference between revisions of "Interaction with SDI-Service"

From Gcube Wiki
Jump to: navigation, search
(REST Interface)
(REST Interface)
Line 17: Line 17:
 
This section describes the interfaces exposed by [[SDI-Service]] and how to interact with it with HTTP requests. It is required that every request is authorized, meaning that it must contain a proper '''gcube token''' (see details [[Authorization_Framework#Token based authorization | here]]).
 
This section describes the interfaces exposed by [[SDI-Service]] and how to interact with it with HTTP requests. It is required that every request is authorized, meaning that it must contain a proper '''gcube token''' (see details [[Authorization_Framework#Token based authorization | here]]).
  
 +
==Exposed Interfaces==
 
The base path for every request is : https://'''<HOSTNAME>'''/sdi-service/gcube/service/
 
The base path for every request is : https://'''<HOSTNAME>'''/sdi-service/gcube/service/
  
==Global configuration==
+
===SDI===
==GeoServer Configuration==
+
===GeoServer===
===Credentials on specific Host===
+
 
 +
==Typical use cases==
 +
===Get global configuration===
 +
===Get available GeoServers===
 +
===Get credentials for a particular GeoServer===
  
 
=Client Library=
 
=Client Library=

Revision as of 11:23, 4 July 2017

SDI-Service is a REST service aimed to offer a simplified interface to SDI administration over the infrastructure and to most common use cases in dealing with geospatial data. This page illustrates the interface exposed by the service and how to interact with it.

Interaction

REST Invocation

SDI-Service is a SmartGears web application offering a REST interface, thus it can be invoked with simple HTTP requests. Every HTTP request to the service must contain a proper gcube-token property (as HTTP header or as query string parameter) in order to be authenticated and authorized. See #REST Interface for interface description.

JAVA Clients

For Java applications, a client library is distributed along with the service. The library facilitates the interaction with the service, automatically dealing with token and providing both an object model and a better fault management (see #Client library for more details). Such library is distributed as a maven artifact with the following coordinates

  <groupId>org.gcube.spatial.data</groupId>
  <artifactId>sdi-library</artifactId>

REST Interface

This section describes the interfaces exposed by SDI-Service and how to interact with it with HTTP requests. It is required that every request is authorized, meaning that it must contain a proper gcube token (see details here).

Exposed Interfaces

The base path for every request is : https://<HOSTNAME>/sdi-service/gcube/service/

SDI

GeoServer

Typical use cases

Get global configuration

Get available GeoServers

Get credentials for a particular GeoServer

Client Library