Deep Links to Official Content - Fluid Topics - 3.2 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
Fluid Topics Version
3.2
Category
Reference Guides
Language
English
Target Audience
public

This section explains how to build URLs to access Fluid Topics contents (a book or a topic in a given book) through the portal.

Deep links are URLs that can be entered in your browser address bar and will point directly to the specified content in the Fluid Topics portal.

All existing facets (native or customized) can be used to build a link pointing to a specific publication.

Deep links to official content only work for content processed starting from Fluid Topics v3.1.

To access a specific map by using facet values:

http://myfluidtopics.com/access/sources/$SOURCE_ID/map?$FACET=$FACET_VALUE&...

Do not use quotes to enter facet values.

To access a specific topic by using facet values:

http://myfluidtopics.com/access/sources/$SOURCE_ID/topic?$FACET=$FACET_VALUE&...

Do not use quotes to enter facet values.

In all deep link web services (for maps, topics, and documents), all query parameters must match the AFS-valid identifier requirements.

When several publications match the requested facet values, the link redirects toward the last published one.

Here is a list of the facets natively added to Fluid Topics content that may be used to generate a deep link:

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

We recommend using the List Maps API to retrieve all relevant metadata.

As a web service

This web service can be used to return the Fluid Topics ID of the resource.

Method

Endpoint

GET

/access/sources/$SOURCE_ID/map?$FACET=$FACET_VALUE&...

Where:

  • $SOURCE_ID is the source identifier.
  • $FACET is the name of the facet as can be seen when listing maps.
  • $FACET_VALUE is the name of the facet value used to find the content.

Output Example

The URL to access the present topic is: https://doc.antidot.net/access/sources/ait/topic?ait:code=20853&FT_Version=3.1

Deep_Links_API

The redirect URL (resource ID) can be found in Location.

It is mandatory to only use 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.