Deep Link to an FTML Book - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

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

/access/sources/$SOURCE_ID/map?ft:ftmap=$FTMAP
/access/sources/$SOURCE_ID/map?ft:baseId=$FTMAP_BASEID
/access/sources/$SOURCE_ID/map?ft:title=$FTMAP_FT_TITLE

Where:

  • $SOURCE_ID is the "id" parameter of the source used to upload the content.

The $SOURCE_ID parameter is case-sensitive.

  • $FTMAP is the name of the map, e.g., my_map.ftmap.
  • $FTMAP_BASEID is the ID of the map in Fluid Topics. It takes the value of the ft:originId attribute of the map, as defined in the Ftmap. It can be retrieved in Fluid Topics by using the Metadata Journal.
  • $FTMAP_FT_TITLE takes the value of the ft:title attribute of the topic, as defined in the Ftmap. It can be retrieved in Fluid Topics by using the Metadata Journal.

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 using the Metadata Journal, we can see that the map ft:baseId is la_fontaine_fables.

The FTML map metadata can be seen in the metadata inspector

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:

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