Deep Link to an Author-it Book - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

The deep link to a Fluid Topics book using Author-it-generated contents takes the following form:

/access/sources/$SOURCE_ID/map?ait:code=$OBJECT_ID&$VARIANT_1=$VARIANT_1_VALUE&$VARIANT_2=$VARIANT_2_VALUE&...

Where:

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

The $SOURCE_ID parameter is case-sensitive.

  • $OBJECT_ID is the "Object code" of the book as generated by Author-it.
  • $VARIANT_N is the name of the variant as created in Author-it. It can be a variant used to generate a facet or not.
  • $VARIANT_N_VALUE is the name of the variant value as created in Author-it.

Sub-books objects from the Author-it export cannot be accessed via their ID, as they are not considered as "publications".

Example

The "My guide" book has been created in Author-it. The following variant values have been applied:

  • Category: Technical Note
  • Version: 2.7, 2.8, 3.0, 3.1
  • Product: Fluid Topics
  • Platform: RHEL, Debian

To access the "3.0" version of this specific book for "Debian", the following path is possible:

/access/sources/ait/map?ft:publication_title=My Guide&Product=Fluid Topics&Version=3.0&Platform=Debian

If the "Object code" of this specific book is 12345, the following path is also possible:

/access/sources/ait/map?ait:code=12345

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

http://myfluidtopics.com/access/sources/ait/map?ait:code=12345
http://myfluidtopics.com/access/sources/ait/map?ft:publication_title=My Guide&Product=Fluid Topics&Version=3.0&Platform=Debian

All variant values can be used to build a link pointing to a specific publication.