Create Deep Links - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

Metadata are a fundamental part of deep links, and it is possible to use both built-in and custom metadata to create one. Built-in metadata commonly used to create a deep link include the following:

  • ft:publication_title - the title of the publication.
  • ft:sourceId - the "id" parameter of the source used to upload the content.
  • ft:sourceName - the "name" parameter of the source used to upload the content.
  • ft:sourceType - the "type" parameter of the source used to upload the content.
  • ft:lastPublication - the date of the last publication. It takes the following format: YYYY-MM-DD.

It is possible to use the List Maps API to retrieve all relevant metadata.

Do not use quotes around metadata values when creating a deep link.

  • The template to build a deep link pointing to a map is as follows:

https://myfluidtopics.com/access/sources/$SOURCE_ID/map?$METADATA=$METADATA_VALUE&...

  • The template to build a deep link pointing to a topic is as follows:

https://myfluidtopics.com/access/sources/$SOURCE_ID/topic?$METADATA=$METADATA_VALUE&...

Example

The present topic, "Build Deep Links," belongs to the book "Use Fluid Topics Web API." The Antidot documentation team published the book via the Author-it connector. Following the instructions provided in Deep Link to Author-it Topic, the deep link pointing to the present topic is as follows:

https://doc.antidot.net/access/sources/ait/topic?ait:code=33631&FT_Version=3.6

Where each element corresponds to the structure of the template as follows:

  1. ait corresponds to $SOURCE_ID
  2. FT_Version corresponds to $METADATA
  3. 3.6 corresponds to $METADATA_VALUE

More examples are available in the following topics:

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.