원격 구성

HTTP API는 서버 환경에서만 사용할 수 있습니다.

HTTP API를 사용하여 사용자에 대한 원격 구성 파라미터 정보를 조회할 수 있습니다.

SDK 키를 통해 인증을 진행합니다.

• SDK 키를 아래와 같이 HTTP 헤더에 추가해주세요.

• SDK 키는 핵클 대시보드 내 SDK 연동 정보에서 확인하실 수 있습니다.

X-HACKLE-API-KEY: {YOUR_SERVER_SDK_KEY}

Request

POST https://api.hackle.io/v1/remote-config

Request Body

defaultValue 의 Type 과 파라미터 유형이 일치하지 않는 경우, defaultValue 의 값을 응답받습니다. (분배사유: TYPE_MISMATCH)

파라미터 유형이 JSON 인 경우 defaultValue 는 string Type 으로 입력해야 합니다.

Field	Type	Required	Description
parameterKey	string	O	원격 구성 파라미터
defaultValue	string, number, boolean	O	원격 구성 값을 결정할 수 없을 때 반환되는 값
user	User object	O	원격 구성 분배 사용자

User Object

Field	Type	Required	Description
userId	string	X	사용자 ID (핵클 통합식별자 사용 가능)
deviceId	string	X	디바이스 ID (핵클 통합 식별자 사용가능)
identifiers	object	X	사용자 정의 식별자 key(string)-value(string) Pair
properties	object	X	사용자 속성 key(string)-value(string

Example

curl -i -X POST \
  'https://api.hackle.io/v1/remote-config' \
  -H 'X-HACKLE-API-KEY: YOUR_SDK_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "parameterKey": "parameter_key",
    "defaultValue": "default_value",
    "user": {
      "userId": "19285035",
      "deviceId": "ae2182e0",
      "identifiers": {
        "sessionId": "16930492542",
        "myCustomId": "ff01eae2"
      },
      "properties": {
        "grade": "GOLD",
        "age": 30,
        "isLogin": true
      }
    }
  }'

Response

200 OK

성공적인 요청인 경우 200 응답과 분배 결과를 반환합니다.

Response Body

Field	Type	Description
value	string, number, boolean	원격 구성 파라미터 값
reason	string	분배사유

Example

{
  "value": "paramter_value",
  "reason": "DEFAULT_RULE"
}

400 Bad Request

유효하지 않은 요청 정보인 경우 400 상태를 반환합니다.

401 Unauthorized

X-HACKLE-API-KEY 헤더값이 없거나 유효하지 않은 SDK 키인 경우 401 상태를 반환합니다