FSA Overview

Welcome to the technical documentation of the Fairgate Standard API (henceforth called FSA) that will allow you to retrieve programmatically data in a read-only fashion from the Fairgate solution to use it externally in other systems via REST-API. Currently the data of the contact module can be retrieved via FSA, you will find the API calls for that based on popular use cases on the API Documentation page.

You have to get the access-token and the public-key of Fairgate from the organisation settings of your organisation to authenticate and validate the JWT signature of FSA calls. The admins can manage the access to their organisation at any time, to give and withdraw. The key is used to gain security with the data of your organisation by verifying the signature of the results to make sure they are from Fairgate. This is done with the JWT.

You can use the SDK we provide to find example code that may help you get started with your API project. Even if you don’t use PHP it may help you understand how it works. If you use PHP it’s a great starting point offering you a usable codebase that runs on most servers out of the box with all needed libraries included and an instruction on how to install it and how to run it.

The FSA-API calls are described in the OpenAPI3 file which you can find on the API Documentation page. You can use the original file also directly for your development and testing tasks in tools like Mockoon or Postman so you can toy around with it, without fear to break anything and with the ability to modify the server response yourself to simulate certain states, which is very handy.

Please take some time to read through the other documentation pages here to understand how Fairgate works and how the API is meant to be used.