Close

User API

사용자 정보를 조회하고, 사용자 서비스를 해제하기 위한 API입니다.

기본 정보

Base URL

서버 형상

 URL 비고
QA (DEV)

https://{region}-qa-ext.lgthinq.com 

region

  • KIC : Asia
  • EIC : Europe
  • AIC : North/South America
OP

https://{region}-ext.lgthinq.com 

API List

Method Summary
GET /users 사용자의 userNumber값을 전달합니다.
DELETE /user/service 해당 서비스에 사용자 연동을 해제합니다. 

사용자 조회

GET /users

Description

이 메서드는 LG ThinQ 사용자의 사용자 번호(userNumber)를 얻어오기 위한 API입니다.

GET {Base_URL}/users

서비스 비식별화 여부에 맞춰서 해당 사용자가 어떤 userNumber를 가지고 있는지 전달합니다.

Parameter

Header Parameters

헤더 파라미터로 공통 헤더를 사용합니다.

Body Parameters

None

 

Example of Request

[GET] {{ENDPOINT_URL}}/users
 
## Header
{
    "Authorization": "Bearer 3b565aa79ac4abaa37809a8b8b745499bd05bb3ef0ed75fe350ad2c696b4b956bddfa35e76c26a12ab33c643bed579dd",
    "x-country-code": "KR",
    "x-message-id": "0123456789012345678912",
    "x-service-id": "470ae4c534ba143cad86e5c3",
    "x-service-key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2aWNlSWQiOiI0NzBhZTRjNTM0YmExNDNjYWQ4NmU1YzMiLCJ0b2tlblNlZWQiOiI1Zjc2MWQwMDU2YmE4NWJkIiwidGltZSI6MTUxNjM0MTkzMn0.aznAEnUItCWc2UAFvoiIYDw0SCJDoY5xVCNnUyUJeiI",
    "content-type": "application/json"
}

Result

이 메서드의 호출 결과는 다음과 같이 2가지 경우(성공, 실패)가 있습니다.

성공

성공한 경우, 사용자의 userNumber가 다음과 같은 형식으로 반환됩니다.

Example of Response

{
    "messageId": "yerPFvgSQZOeZuVO7Onnpw",
    "timestamp": "2023-12-27T05:28:17.739840",
    "response": { "userNumber": "SaGvM4ETAgOHSAFhezzi" }
}

실패

​실패한 경우, Common Response에 정의된 응답 규약에 따라 에러 코드와 에러 메시지가 반환됩니다.

Example of Response

{
    "messageId": "yerPFvgSQZOeZuVO7Onnpw",
    "timestamp": "2023-12-27T05:28:17.739840",
    "error": {
            "message": "Not registered user",
            "code": "1202"
     }
}

 

사용자 서비스 해제

DELETE /user/service

Description

이 메서드는 해당 사용자의 서비스 해제를 위한 API입니다. 

DELETE {Base_URL}/user/service

더 이상 해당 사용자가 API를 연동하지 않을 때 호출합니다.

 

Parameter

Header Parameters

헤더 파라미터로 공통 헤더를 사용합니다.

Body Parameters

None

 

Result

이 메서드의 호출 결과는 다음과 같이 2가지 경우(성공, 실패)가 있습니다.

성공

성공한 경우, 비어있는 값을 반환합니다.

실패

​실패한 경우, Common Response에 정의된 응답 규약에 따라 에러 코드와 에러 메시지가 반환됩니다.

 

Example of Request

[DELETE] {{ENDPOINT_URL}}/user/service
 
## Header
{
    "Authorization": "Bearer 3b565aa79ac4abaa37809a8b8b745499bd05bb3ef0ed75fe350ad2c696b4b956bddfa35e76c26a12ab33c643bed579dd",
    "x-country-code": "KR",
    "x-message-id": "0123456789012345678912",
    "x-service-id": "470ae4c534ba143cad86e5c3",
    "x-service-key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2aWNlSWQiOiI0NzBhZTRjNTM0YmExNDNjYWQ4NmU1YzMiLCJ0b2tlblNlZWQiOiI1Zjc2MWQwMDU2YmE4NWJkIiwidGltZSI6MTUxNjM0MTkzMn0.aznAEnUItCWc2UAFvoiIYDw0SCJDoY5xVCNnUyUJeiI",
    "content-type": "application/json"
}

Example of Response

{
    "messageId": "kZo3GvwMTsSYGpqHgaz8RA",
    "timestamp": "2023-12-20T06:29:10.344852",
    "response": {}
}