RESTful API endpoints are one of the channels to the GFM data access and dissemination system, regardless configuration services, product order or product serving services.
All GFM-related RESTful APIs are written in Python with the Flask framework for web application. Flask is a lightweight Web Server Gateway Interface (WSGI) web application framework written in Python. The API gateway is exposed to the web by NGINX webservers which handle all requests from the internet and route them to WSGI HTTP servers, in our case Gunicorn. Gunicorn translates the requests in WSGI compliant calls and moves the proper request to the pool of workers, which are executing the request. After successful executing the result is converted by Gunicorn to the HTTP request and handed over to NGINX, which takes care of the final delivery. Load-balancing is be handled by NGINX to serve the appropriate amounts of HTTP servers for the GFM data access and dissemination system.
Note that all components for the RESTful API access are distributed as open and free licenses.
¶ GFM API documentation
The documentation about how to configure GFM-related RESTful APIs is made available through the popular Swagger UI allowing end-users and/or development teams to visualize and interact with the APIs resources without having any of the implementation logic in place.
All the API functions are listed below, the online guide and tutorial are available at on-line and in the Quick Start Guide
¶ Download limitations
Please bear in mind that:
- for the maximum flood extent, the length of the selected timeframe cannot be longer than 2 months
- for all other layers the limit is 6 months
¶ How to get a token
To use the set of APIs, users need to get an access token. Information on how the access token could be retrieved are given in the dedicated section of the GFM WebApp.
¶ Auth (endpoint specification related to authentication operations)
¶ Users (endpoint specification related to users operations)
¶ Download (endpoint specification related to the GFM product download)
¶ Legend (endpoint specification related to product legends)
¶ Notifications (endpoint specification related to the notification service)
¶ Products (endpoint specification related to the GFM products)
¶ Reporting (endpoint specification related to the GFM report generation)
¶ AOI (endpoint specification related to the area of interest)
¶ Support (endpoint specification related to support requests)
¶ Utils (endpoint specification for general operations)
