Deep link to an FTML book - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

The URL of a Fluid Topics book using the architecture of the published ZIP archive takes one the following forms:

/access/sources/{sourceId}/map?ft:ftmap=$FTMAP
/access/sources/{sourceId}/map?ft:baseId=$FTMAP_BASEID
/access/sources/{sourceId}/map?ft:title=$FTMAP_FT_TITLE
Path parameter Type Description
{sourceId} String The id parameter of the source used to upload the content.

The {sourceId} parameter is case-sensitive.

Query parameter Type Required? Description
$FTMAP String Yes The name of the map, e.g., my_map.ftmap.
$FTMAP_BASEID String Yes ID of the map in Fluid Topics. It takes the value of the ft:originId attribute of the map, as defined in the FTML map. It can be retrieved in Fluid Topics by viewing a structured document's metadata.
$FTMAP_FT_TITLE String Yes Takes the value of the ft:title attribute of the topic, as defined in the FTML map. It can be retrieved in Fluid Topics by viewing a structured document's metadata.

Example

Given the following FTML archive uploaded through the ftml source:

ftml.zip
├── la-fontaine-fables.ftmap
└── topics
      ├── hare-tortoise.html
      └── grasshopper-ant.html

When the "La Fontaine's Fables" map is opened in the Reader page, by viewing a structured document's metadata, we can see that the map ft:baseId is la_fontaine_fables.

alt text_to_do

To access the map, use either one of the following paths:

/access/sources/ftml/map?ft:ftmap=la-fontaine-fables.ftmap
/access/sources/ftml/map?ft:baseId=la_fontaine_fables
/access/sources/ftml/map?ft:title=La Fontaine's Fables

It is then possible to share this map by using either one of the following links:

https://myfluidtopics.com/access/sources/ftml/map?ft:ftmap=la-fontaine-fables.ftmap
https://myfluidtopics.com/access/sources/ftml/map?ft:baseId=la_fontaine_fables
https://myfluidtopics.com/access/sources/ftml/map?ft:title=La Fontaine's Fables

Updating a document's title will break a deep link using the ft:title metadata.