Data Services API

Overview

An API, or Application Programming Interface, facilitates communication between applications through a standard communication protocol.

The Data Services API is an endeavor by MDI to standardize and expand the communication between the FIMMAS system and external applications. It is not a replacement for the applications used by home office staff.

The Data Services API provides the building blocks necessary to provide your users with secure access to the FIMMAS system. The Data Services API does not provide any specific display formatting. Only raw data is passed through the API in JSON format and it is up to the client side implementation to style the data as needed.

The Data Services API is organized around REST principles and design patterns. The API, by default, strives to define predictable URLs and use standard HTTP response codes, http headers, and HTTP methods. All of these are customizable from within FIMMAS API mapping, allowing you to securely interact with our API from any external application. All response bodies are JSON encoded.

System Requirements

  1. The FIMMAS Data Services API is compiled for and tested on Windows Server 2012 R2 and Red Hat Enterprise Linux 7, but may work fine with other versions of Windows or Linux.
  2. The FIMMAS Data Services API will need to have network access to both the FIMMAS server and the application server that will be integrated.
  3. If you wish to allow upload and or download of documents through the API, the FIMMAS Data Services API will require access to a file server that is also accessible by FIMMAS.
  4. APPX version 5.4.6 or later.

Sections

  • Setup
    Information for system administrators that will be installing, configuring, and maintaining the FIMMAS Data Services API
  • Usage
    Information about the functionality included with the FIMMAS Data Services API