Event API

기본 정보

BaseURL

Phase	KIC	AIC	EIC	Description
OP	https://kic-laundry-ext.lgthinq.com	-	-	운영
QA	https://kic-laundry-ext-qa.lgthinq.com	-	-	개발 및 테스트

API List

Method	End-point	Response Format	Summary
PUT	{{BASE_URL}}/event/callback	JSON	Callback URL을 등록합니다.

 

Callback 등록

PUT {{BASE_URL}}/event/callback

기기 상태 변경, 기기 종료 알림 등을 수신하기 위한 Callback URL을 등록합니다.

요청

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Body	request
	└	url	Mandatory	string	Callback URL	https://test.com

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name					Type	Required	Description	Example
resultCode					string	Mandatory	결과 코드	"0000"
result					dict	Mandatory	결과 데이터	-

실패

실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[PUT] {{ENDPOINT_URL}}/event/callback

{
  "request": {
    "callbackURL": "https://test.com"
  }
}

Response

{
  "resultCode": "0000",
  "result" {
    "callbackURL": "https://test.com"
  }
}