1. API Introduction | Getting Started

API Intro

The Go2Clock web platform instance allows for a central, online time & attendance solution.

The platform can directly accept data from a range of traditional hardware time clocks or from 3rd party software applications or custom hardware platforms such as smartphones etc.


Goals

The purpose of this document is to help system integrators to understand how to interface with the Go2Clock platform.


Solution

The Go2Clock API is a RESTful service that implements the transferring of data over a standard HTTPS connection using GET, PUT or POST style commands. The API will use either plain text or JSON responses along with HTTP header page responses for success or failure.

It is very easy to implement because it is platform-independent, meaning you can develop your client solution in the programming language of your choice.


Requirements

In order to communicate with a Go2Clock server instance you will need to know the web address of the instance and also know the unique API security key from the instance.


The API security key has to first be created within the Go2Clock instance, from the Settings > API key.

You will therefore need Admin login access to create a key or have an admin of the instance do this for you.


The system allows for multiple API keys to be generated, so each platform or app that needs to communicate with the Go2Clock instance should have its own API key configured.


IMPORTANT: Do NOT share API keys with multiple apps or users.


Once you have created a key you can begin communicating with the Go2Clock server.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us