Close

Common Header

공통 헤더에는 ThinQ Connect API에서 공통적으로 사용하는 파라미터들이 정의되어 있습니다.

Name

Type

Required

Description

Default

Example

Authorization

string

mandatory
  • LG EMP(Enterprise Membership Platform)에서 사용자 인증을 위해 OAuth 표준에 따라 발급해주는 토큰 값입니다.
  • 이 토큰을 이용하여, LG ThinQ 플랫폼은 어떤 사용자의 디바이스 정보를 제공해야 하는지 사용자를 식별하고, 여러분의 서비스가 해당 사용자의 디바이스 정보를 이용하도록 승인받았는지를 확인합니다.
  • OAuth 2.0 규격에 맞추어, 토큰 값 앞에 타입 Bearer를 선언합니다.

Bearer {token}

None

 
"Authorization" : "Bearer 5a9a713f51a95c53d781addd1af0dfa4f6e1e7420a8bff3c5198308dac571aa9845832b8d29bbe1f04deec2d35229c6d",

x-country-code

string

mandatory
  • 여러분의 서비스를 제공할 국가를 지정할 수 있습니다. 가능한 국가 코드는 Common Data Type > Country Code 를 참조하시기 바랍니다.

None

 
"x-country-code" : "KR",

x-message-id

string

mandatory
API 호출 시마다 매번 새로운 고유값을 생성하여 입력해야 합니다.
  • LG ThinQ 플랫폼으로 요청되는 정보를 추적하기 위한 값입니다. 특정 API의 흐름을 추적하고 에러 발생 시 원인을 찾을 수 있습니다.
  • 생성 규칙
    • url-safe-base64-no-padding (UUID Version 4) 방법으로 생성합니다.
    • 길이는 22자입니다.
    • Example code (Python)

import uuid
import base64
messageId = base64.urlsafe_b64encode(uuid.uuid4().bytes)[:-2]

None

 
"x-message-id" : "0123456789012345678912",

x-service-id

string

mandatory
  • 여러분의 서비스를 LG ThinQ 플랫폼에 등록한 후에 발급되는 서비스 ID 값입니다. 서비스 KEY 값과 함께 LG ThinQ 플랫폼에서 여러분의 서비스를 식별하는 데 사용됩니다.

None

 
"x-service-id" : "470ae4c534ba143cad86e5c3",

x-service-key

string

mandatory
  • 여러분의 서비스를 LG ThinQ 플랫폼에 등록한 후에 발급되는 서비스 KEY 값입니다. 서비스 ID와 함께 LG ThinQ 플랫폼에서 여러분의 서비스를 식별하는 데 사용됩니다.
  • 이 KEY 값은 만료 기한이 없습니다. 하지만 요청에 의해 KEY 갱신이 가능하며 보안을 위해 주기적으로 갱신할 것을 권장합니다.

None

 
" x-service-key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2aWNlSWQiOiI0NzBhZTRjNTM0YmExNDNjYWQ4NmU1YzMiLCJ0b2tlblNlZWQiOiI1Zjc2MWQwMDU2YmE4NWJkIiwidGltZSI6MTUxNjM0MTkzMn0.aznAEnUItCWc2UAFvoiIYDw0SCJDoY5xVCNnUyUJeiI",

x-conditional-control

boolean

optional
  • 디바이스 제어(POST /devices/{device-id}) 시에만 사용하는 값입니다.
    • true 입력 시
      • 제어 가능한 상태인지 확인한 후 제어를 수행합니다. 제어가 불가능한 경우 응답으로 Error Code 2302 혹은 2305를 반환합니다. 
    • false 입력 시
      • 제어 가능 상태인지 확인하지 않고 바로 제어를 수행합니다. 

true

 
"x-conditional-control" : true,