Fluid Topics Web Services - Fluid Topics - 3.3 - Reference Guides

Fluid Topics API Reference Guide

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

Fluid Topics exposes some of its features through web services. They are JSON-based REST web services.

Fluid Topics web services are backward-compatible. Various fields may be added to enrich Web Services output format. If JSON output decoding is done by an object mapper, it should be configured to ignore unknown fields.

The web service descriptions always give a path and not a complete URL. It has to be prefixed with the Fluid Topics portal root URL to get the full URL to call.

The web services are presented as follows:

Methods

Description

GET

Used to retrieve information.

POST

Used to upload data.

PUT

Used to modify data.

DELETE

Used to delete data.

Endpoint

The endpoint is used to call the specific API.

To apply the GET method, it can simply be added at the end of the URL, for example:

http://doc.antidot.net/api/users

Other methods (PUT, POST, DELETE) might necessitate a Rest API client.

Example of a call to a web service with CURL

With CURL, use printf, not echo. Echo generates a carriage return, invalidating the command.

$ curl http://doc.antidot.net/api/users -H "FT-Authorization: Basic $(printf root@fluidtopics.com:PASSWORD | base64)"
[{"id":"f6799959-765e-4319-a156-c09ad3251366","displayName":"Fluid Topics Root User","emailAddress":"root@fluidtopics.com"}]

For more information about Web Services, see Representational state transfer applied to web services.