Get a Map's Title - Fluid Topics - 3.6 - Technical Notes

Integrate Fluid Topics APIs

Product
Fluid Topics
Fluid Topics Version
3.6
Category
Technical Notes
Language
English
Target Audience
public

The List Maps web service returns a list of all maps available on the Fluid Topics server:

/api/khub/maps



- User rights are taken into account when the appropriate Authorization header is provided, otherwise only public results are returned. Before Fluid Topics v3.4.12, Fluid Topics systematically used a prefixed version of the header: FT-Authorization. From Fluid Topics v3.4.12, both prefixed and not prefixed headers work.

- Clustering is not available for this web service.

After listing the maps, it is possible to use endpoints to target and retrieve specific information within a map. The following lines show an example of the List Maps web service implementation in Python.

#!/usr/bin/env python3
import requests
FT_SERVER_URL = 'https:// <host>/<serviceId>/<status>/'

#
MAPS_ENDPOINT = '/api/khub/maps'

#
HEADERS = {'FT-Authorization': 'Basic ...'}

#
def crawl_maps():
URL = FT_SERVER_URL + MAPS_ENDPOINT
...

#
def crawl_map(map_preview):
URL = FT_SERVER_URL + map_preview['mapApiEndpoint']
...

Use a REST Client tool like Postman to retrieve the Basic authentication key as in the following illustration: The Basic authentication key can be retrieved using Postman

Since the List Maps web service returns all maps on a Fluid Topics server, it is also possible to use it to crawl maps.