InGeoCloudS API

Printer-friendly versionSend by emailPDF version

The Representational State Transfer (REST) design model for exposing RESTful web services has been chosen for the implementation of the InGeoCloudS API. The InGeoCloudS technical components are implementing RESTful web services serving requests issued over the HTTP protocol. An application provider can use the InGeoCloudS API to integrate a new application into the platform.

The InGeoCloudS API was implemented using Jersey in integration with the Enunciate documentation engine. Enunciate supports the automatic production of the following information: HTML API documentation, interface definition documents, such as WADL and WSDL as well as schemas (XSDs). This ensures an always updated API documentation in relation to the latest code version.

This documentation is available at https://portal.ingeoclouds.eu/ingeoclouds-api/ and provides information on the REST resources exposed by the different IGC components (see Figure 6 for a screenshot and follow hyperlinks below):

  • IGC Management Component (implemented by the Master Service resources). This is the core of the platform API. It is in charge of monitoring the InGeoCloudS infrastructure and of orchestrating operations involving several components, e.g., backup of database, file system and configurations.

  • Elastic File Server Component (implemented by the Elastic File System Service resources). This component offers a distributed and scalable file system that is transparently accessible through NFS-like protocol.

  • Elastic Database Component (implemented by the Elastic Database Service resources). This component offers an elastic database management system facility for data providers, ensuring scalable storage capacity, high availability of data and performance.

  • Data Import Component (implemented by the Data import resources). The services exposed by this component are used by data providers to import data in the InGeoCloudS platform.

  • Elastic Geospatial Server Component (implemented by the Elastic Map Server System Service resources)

  • Data publication Component (implemented by the Data Publication – MapFile Service and Data publication - Data store service resources). The Data Publication API manages the creation and the publication of INSPIRE services and OGC services: WMS and WFS services will be generated from geo-spatial datasets beforehand uploaded in the infrastructure.

  • Linked Data Management Services (implemented by the MetaDataServiceImpl resources). These services provide access to the RDF/S Knowledge Base in order to allow applications and users to import and export data to it, perform queries and allow for controlled updates of the data (more details are given in section 3.6.4).

  • Geo Processing (Geo Processing Service) is usefull every time the Provider needs a dedicated node to perform some special operations. This interface is able to start a custom node and menage it. For security reason is possible to use the geoprocessing methods only on the instances started using the geoprocessing interface. Furthermore it implements a mechanism to avoid interfrence between different providers. Only the provider who started an instance can modify its status.

For each component, the following information is provided:

  • Exposed RESTful Web Services

  • Call method (POST, PUT, GET)

  • Small description of the service

  • Call parameters

  • Response body

  • Return status codes

For more detailed descriptions on the InGeoCloudS Web Services along with usage guidelines and examples use visit the respective pages in this wiki.