HyperTrack REST API

The HyperTrack API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. To make API calls, use our helper libraries or any HTTP client.

To try out our APIs, use our Postman collection.

[info] Base HTTP URL

The base URL is https://api.hypertrack.com/api/v2/, with entity URLs like https://api.hypertrack.com/api/v2/actions/. Every URL ends with a forward-slash /.

Postman collection

Run in Postman

Remember to

  • Sign up and get your SECRET_KEY, which you need to set as hypertrack_sk collection variable.
  • Run the 1st folder of the collection. This will run the requests in that folder and automatically set global variables like user_id, action_id and so on, that are used by other requests in this collection.

Authentication

In order to use HyperTrack, you will need authenticate using keys. You can get your keys by visiting the Account section of your Dashboard. If you don't already have an account, sign up here.

The HyperTrack API follows HTTP basic auth to authenticate API calls with a token. Every API call needs to have the Authorization key sent in the request header with the token.

Use your PUBLISHABLE_KEY (looks like pk_1234567890abcde) to authenticate HTTP API calls. Use your SECRET_KEY (looks like sk_1234567890abcde) for list API calls where you don't send an identifier in the parameter.

Helper libraries

To make your server-side integration easier, you can use one of our following helpers libraries. These can be directly imported to your application. If your language of choice is not listed, you can use any HTTP requests library to make API calls.

Python

The hypertrack-python library can be installed using pip.

$ pip install hypertrack
import hypertrack
# Initialize the library with the secret token
hypertrack.secret_key = 'SECRET_KEY'

Java

The hypertrack-java library can be installed using maven.

<dependency>
  <groupId>io.hypertrack</groupId>
  <artifactId>hypertrack-java</artifactId>
  <version>1.0.0</version>
</dependency>
import io.hypertrack.net.HyperTrackClient;

public class SimpleExample {
    public static void main( String[] args ) throws Exception
    {
        /* Create client instance with secret token. */
        HyperTrackClient client = new HyperTrackClient("SECRET_KEY");
    }
}

Node.js

The hypertrack-node-sdk library can be installed using npm.

$ npm install hypertrack-node
var hypertrack = require('hypertrack-node')('<SECRET_KEY>');

Ruby

The hypertrack-ruby library can be installed using gem.

$ gem install hypertrack
require 'hypertrack'
HyperTrack.secret_key = "<SECRET_KEY>"
HyperTrack.api_version = "v2" # Need v0.2.0 or above for V2 support. Default is v1.

HTTP request headers

In case you are not using a helper library, you will need to add these keys to your request headers.

Authorization

The API follows HTTP basic auth to authenticate API calls with a token. Every API call needs to have the Authorization key sent in the request header with the token, as shown below.

Authorization: token sk_1234567890abcde

Content type

While sending POST requests with a JSON body, remember to add the Content-Type header to define input format.

Content-Type: application/json

API error codes

The HyperTrack REST API uses the following error codes. For each error response, the response content contains information on what is wrong.

Error code Meaning
301 Redirect to correct API url
400 Missing or invalid parameters in API call
401 Missing or invalid API key
402 You are accessing a paid resource without billing setup
403 You don’t have permission to access the resource, verify your key
404 The resource does not exist, check the URL
405 You tried to access a resource with an invalid HTTP method
5xx There was an error on the server and we have been notified

results matching ""

    No results matching ""