Hackle Proxy API

This document provides and describes the API for calling Hackle Proxy.

📘 Prerequisites

This can be used after installing Hackle Proxy.

Common Headers

To call the Hackle Proxy server, you must include the SDK Key in the Header. If the SDK Key is missing or does not match the SDK_KEYS registered at server startup, an error will occur.

X-HACKLE-SDK-KEY: {YOUR_SDK_KEY}

API

1. Variation

The Variation API determines the Variation to expose to a user.

POST /api/v1/variation

1.1 Request

{
  "experimentKey" : number,
  "userId" : string
}

1.2 Response

Response status code : 200

Body

{
  "variation" : string // A, B, C, D, E, F, G, H, I, J
}

When an error occurs, you can identify the API issue by the following response codes:

• 400 : Bad Request - Occurs when the request body is missing or in an incorrect format.

• 401 : Unauthorized - Occurs when the SDK_KEY in the header is missing or incorrect.

• 500 : Internal Server Error

2. Track

The Track API is used to track user events.

POST /api/v1/track

2.1 Request

{
  "eventKey" : string,
  "userId" : string,
  "value" : number // Optional (default=0.0)
}

2.2 Response

Response status code : 202 When an error occurs, you can identify the API issue by the following response codes:

• 400 : Bad Request - Occurs when the request body is missing or in an incorrect format.

• 401 : Unauthorized - Occurs when the SDK_KEY in the header is missing or incorrect.

• 500 : Internal Server Error