Deep Link to an FTML Topic - 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 topic using the architecture of the published ZIP archive takes the following forms:

/access/sources/$SOURCE_ID/topic?ft:baseId=$FTML_TOPIC_BASEID
/access/sources/$SOURCE_ID/topic?ft:title=$TOPIC_FT_TITLE

Where:

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

The $SOURCE_ID parameter is case-sensitive.

  • $FTML_TOPIC_BASEID is the ID of the topic in Fluid Topics. It takes the value of the ft:originId attribute of the topic, as defined in the Ftmap. It can be retrieved in Fluid Topics by using the Metadata Journal.
  • $TOPIC_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 "The Hare and the Tortoise" topic is opened in the Reader page, by using the Metadata Journal, we can see that the topic ft:baseId is hare_and_tortoise.

The FTML topic metadata can be seen in the metadata inspector

To access the second topic, use either one of the following paths:

/access/sources/ftml/topic?ft:baseId=hare_and_tortoise
/access/sources/ftml/topic?ft:title=The Hare and the Tortoise

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

http://myfluidtopics.com/access/sources/ftml/topic?ft:baseId=hare_and_tortoise
http://myfluidtopics.com/access/sources/ftml/topic?ft:title=The Hare and the Tortoise

It is mandatory to only public web services for the portal. Public web services are the ones listed in this document. Antidot cannot be held responsible for any damage resulting from the use of private web services.