Introduction

An application programming interface (API) is a protocol intended to be used as an interface by software components to communicate with each other. The FirstClass Web Services server (FCWS) is a Python implementation of a web server that facilitates access to FirstClass server data and functionality. The FirstClass web client (or any other web-based client) uses HTML 5.0 to communicate with the FirstClass web server. Requests issued to the FirstClass web server are translated into the FirstClass-proprietary protocol FCP and sent to the FirstClass server for processing. The FirstClass server responses are also encapsulated in the FCP protocol, which is then processed by the FirstClass web server and subsequently sent back to the web client.
The API is documented and web developers can use this API to create applications that can present secure, authenticated data within their own applications.

The API Toolkit is four different applications that will be described further in this document. The Index.html file is the table of contents and each of the different pages share content (either images or CSS) that is stored in the images and Commonjs folders. The above diagram shows the relationships in the file structure.
The files will be described in more detail shortly.

All of the applications must point to your instance of FCWS which, in itself must be configured to have a default server.
For the API Tool, you must enter your server ipaddress and the port on which fcws is listening.
Note: If you want to initiate a password change you will have to have and SSL Connection

1. default server
2. port

The most current API documentation can be found in your FCWS/Docs folder on your own installation. This will be updated with each server update as required so be sure to check for changes after each server upgrade.