Introduction

The Health Vectors API is built around REST. We stay away from the polling mechanism on either side to avoid redundant resource wastage. We believe in the “I will call you when I am ready” paradigm and hence have webhook like framework built into the REST API mechanism. There are broadly 2 functionalities that have to be elaborated for a handshake between Health Vectors system and the Client (consuming party which requests the Health Vectors Report).

Data push from Client to Health Vectors
– This will be an API which will be provided by Health Vectors and is used to push data to our servers. The response back from Health Vectors will contain only the response code of whether the data has been received successfully or not. This will NOT return the smart report.
Generated report URL to be pushed back to the client
– A webhook needs to be exposed by the client which will be called by Health Vectors when report generation is done or if there is an error in the generation. The payload will contain standard HTTP response codes and details.

Authentication

The Health Vectors API uses API keys to authenticate requests. Test mode secret keys have the prefix hv_test_ and live mode secret keys have the prefix hv_live_. The API key has to be passed in the header as a header parameter. Alternatively, you can use restricted API keys for granular permissions. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without API key will also fail

Errors

Health Vectors uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 5xx range indicate an error. The error description and remedy will be provided. If its an internal error, that will also be provided back for correction.

* Note for Clients

APIs will return a HTTP 200 OK success status response code to client if data is saved successfully for processing. If client does not receive HTTP 200 response code after pushing data, client to repush data with a 10 mins duration till http 200 code is received back
If multiple records are being pushed in a batch – client to time the data push such that not more than 60 records are pushed per 1 min
Smart Reports are not available for individuals aged 14 years and less
Smart Reports are not available for pregnant women