Skip to main content

All products

FairCom documentation for all products

Section

Description

5 Minute tutorials

This section provides links to 5-minute tutorials that will give you a kick-start with any of the FairCom drivers.

Admin API

This section describes FairCom’s server administrative API. The API uses the jsonAction protocol. The API contains actions for managing the server. The server endpoint over HTTP is /api.

Administrators guide

This section contains the information necessary for a system administrator to manage a FairCom server.

APIs

This page lists all of the FairCom APIs.

Data replication

This section is a full reference to FairCom Replication Manager features and capabilities.

Error codes

This section presents a numerical listing of the error codes that could be generated by all FairCom products.

FairCom DB Notify

This section covers FairCom DB Notify which automatically captures data change events and publishes them as MQTT messages. Any system subscribed to these messages will receive guaranteed notification of data changes.

Field types

This section describes the valid data types for fields in tables and properties in JSON documents.

Glossary

The glossary contains all major terms used by FairCom products. It also contains related terms.

Install FairCom products

This section provides quick and advanced installation instructions for all FairCom products along with a section on creating Docker containers for FairCom servers.

jsonAction API

This section covers the standard message pattern for jsonAction APIs and includes detailed descriptions of all properties.

Quick startQuick start

This section gets you started with real-world programming in a hurry.

User interfaces

This section provides overviews of the FairCom user interfaces with tutorials on how to use them.