API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other. API is a set of routines, protocols, and tools for building software applications. An API specifies how software components should interact and can be used when programming graphical user interface (GUI) components. API documentation lists the methods and requirements for interfacing processes and exchanging data. Many APIs are based on typically hypertext resident Web Services standards such as REST, SOAP, XML-RPC and JSON-RPC.

 

RESTful Web Services are any of a group of approaches that conform to the principles of Representational State Transfer (REST) architecture. REST principles call for stateless client/server architecture typically based on HTTP.  They conform to the use of Universal Resource Indicators (URIs) and use the CRED methods of PUT, GET, POST and DELETE. Resources are represented and therefore decoupled from their source. Messages are self-descriptive. Stateful interactions are achieved through hyperlinks. Since all interactions with resources are stateless because the requesting message is self-contained, explicit state transfer is used to achieve stateful interactions. Transfer of XML or JSON is used.

 

The SatX API relies on the SaVoir SatX component to provide a RESTful service, which offers the user a set of methods for retrieving and modifying the following resources:

  • Scenario
  • Constellations
  • Satellites
  • Sensors
  • Orbits
  • Antennas
  • Areas of Interest

It also provides many interaction functions based on those resources like for example swath intersection schedules, antenna Azimuth-Elevation reports, and many more.

All resources are encoded as JSON objects.

Video Tutorial

A tutorial video to show how it is possible to use SatX WebSite and its features.

Swaths Tutorial

An example on how to obtain the intersections between the satellites swaths and the areas of interest.

 

New Features

A new version of SatX WebSite has been released. Watch this video to discover new features available.

This project has received funding from the European Union’s H2020 research and innovation programme under Grant Agreement No 783850