APIs makes it possible to share fSeries data and documents with with other fSeries systems and (with additional External module) other systems.

The basic option permits other fSeries systems to connect to and gather data and documents from your system (subject to security).

The enhanced option makes it possible for systems other than another fSeries system to use your APIs.

There are two elements to an API:

1. Create an API entity by selecting a DSD or fDocs/fSheets template to be made available
2. Set a “route” by which eternal system can address the API

An API entity wraps a DSD or fDocs/fSheets template entity, making it available as an API. Some settings may be applied, in particular the format in which the data/document is returned, although this may be left for the caller to specify (e.g. to permit the calling system to specify docx or pdf for a document).

The API entity is set up using the APIs Designer.

Once an API has been published it requires a “route” to be created by which an external system may access it. the route is the part of the URL that locates the API (resource) and provides parameters. The route will provide a RESTful resource specification that you can design how you wish.

The API Route is set up using the APIs Route editor.

A separate document is available with more information about setting up and using fSeries API.