• 서울특별시 중구 을지로 65 대표이사/사장 유영상
  • 사업자등록번호 104-81-37225
  • Powered by SK텔레콤

Authentication

NUGU 플랫폼 인증은 OAuth 2.0의 규격을 지원하고, NUGU의 회원 체계는 SK텔레콤의 T아이디를 따릅니다.

플랫폼 인증을 위해서는 NUGU에서 별도로 발급하는 Client Id, Client Secret과 제휴사에서 등록한 Redirect Uri 정보가 필요합니다. 인증 정보는 체험판 신청으로 발급 받을 수 있으며, 정식판 제휴 시에는 PoC 관리 메뉴에서 발급 받은 정보를 확인 할 수 있습니다.

Authorize Endpoint

response_type=code 만 사용 됩니다.

data 파라미터를 사용하여 디바이스 일련번호를 전달 할 수 있습니다.

{“deviceSerialNumber”:”DEVICE_SERIAL_NUMBER”}

GET
https://api.host.domain /v1/auth/oauth/authorize
인증 요청 (Authorize Endpoint)
NUGU계정 미사용, 체험판 사용 시에는 불필요합니다.
Parameters
Query
client_id string 발급받은 ClientId를 사용 합니다.
response_type string code 만 사용 됩니다.
redirect_uri string 설정한 RedirectUri를 사용합니다.
scope string (TODO)
data string 추가적인 데이터를 포함됩니다.
state string CSRF를 위해 사용 되는 값입니다.
Response
302
Header
복사성공! 


1
2
3



HTTP/1.1 302 
Date: Mon, 14 Oct 2019 02:24:58 GMT
Location: {redirect_uri}?code={code}&state={state}

Token Endpoint

grant_type=refresh_token, grant_type=authorization_code , grant_type=client_credentials 가사용 됩니다.

NUGU계정 미사용, 체험판은 grant_type=client_credentials 을 사용합니다.

Client 인증 정보는 Body Parameter(application/x-www-form-urlencoded)를 사용 합니다.

POST
https://api.host.domain /v1/auth/oauth/token
토큰 요청 (Token Endpoint)
NUGU계정 미사용, 체험판 사용 시에는 code와 redirect_url 입력이 불필요합니다.
Parameters
Body
data string 추가적인 데이터가 포함 됩니다. ex) {"deviceSerialNumber":"DEVICE_SERIAL_NUMBER"}
grant_type string authorization_code (신규), client_credentials (NUGU 회원 미사용, 체험판)
code string 응답 받은 code 값을 사용 합니다.
redirect_uri string 인증 요청 시 사용된 redirect_uri를 사용합니다.
client_id string 발급 받은 ClientId를 사용합니다.
client_secret string 발급 받은 ClientSecret을 사용합니다.
Response
200
Header
복사성공! 


1
2
3



HTTP/1.1 200 
Date: Mon, 14 Oct 2019 02:24:59 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4
5
6
7



{
  "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM3MTg1MDM1NDYsInVzZXJfbmFtZSI6IkFMREZBS0sxQjhaUjU2MzE1QzVEIiwianRpIjoiYWU4ZWQ0MTEtZTljYy00NGRjLThlYjUtODc4NTdjM2QzNmFlIiwiY2xpZW50X2lkIjoic3BlYWtlci5udWd1Lm51MTEwIiwic2NvcGUiOltdLCJleHQiOnsidXNyIjoiQUxERkFLSzFCOFpSNTYzMTVDNUQiLCJwb2MiOiJzcGVha2VyLm51Z3UubnUxMTAiLCJkdmMiOiJBTERGRzU1WU1ZUkE5RTUyN0VCRCIsInRrbiI6IjNDNzMxMzEwOUIyQTQ1RTZCQjhBRUQ2MjBGRjNBMThGIn19.DrmLXJXBF9YL7-R7gtEg5dOLQ7UfYMlPKGp1WHNfx8M",
  "token_type" : "Bearer",
  "refresh_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NzM2MTE4OTksInVzZXJfbmFtZSI6IkFMREZBS0sxQjhaUjU2MzE1QzVEIiwianRpIjoiNjAzYTkyNjUtNTJmNS00ZDE2LWEzOWYtMTVkMGZhM2IxMTgyIiwiY2xpZW50X2lkIjoic3BlYWtlci5udWd1Lm51MTEwIiwic2NvcGUiOltdLCJhdGkiOiJhZThlZDQxMS1lOWNjLTQ0ZGMtOGViNS04Nzg1N2MzZDM2YWUiLCJleHQiOnsidXNyIjoiQUxERkFLSzFCOFpSNTYzMTVDNUQiLCJkdmMiOiJBTERGRzU1WU1ZUkE5RTUyN0VCRCIsInBvYyI6InNwZWFrZXIubnVndS5udTExMCIsInRrbiI6IjNDNzMxMzEwOUIyQTQ1RTZCQjhBRUQ2MjBGRjNBMThGIn19.F29whyNRE6LN3c9yfNTH3F9uN3W04aP2Jxav3rSSFoY",
  "expires_in" : 2147483646,
  "jti" : "ae8ed411-e9cc-44dc-8eb5-87857c3d36ae"
}
400
Header
복사성공! 


1
2
3



HTTP/1.1 400 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_grant",
  "error_description": "Invalid authorization code: 0rrbEjnOfqxIv6uNic6C"
}
401
Header
복사성공! 


1
2
3
4



HTTP/1.1 401 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
WWW-Authenticate: Form realm="NUGU", error="invalid_client", error_description="Bad client credentials"
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_client",
  "error_description": "Bad client credentials"
}
POST
https://api.host.domain /v1/auth/oauth/token
토큰 갱신 요청 (Token Endpoint)
NUGU계정 미사용, 체험판 사용 시에는 불필요합니다.
Parameters
Body
data string 추가적인 데이터가 포함 됩니다. ex) {"deviceSerialNumber":"DEVICE_SEERIAL_NUMBER"}
grant_type string refresh_token (갱신)
refresh_token string 신규 발급 시 응답 받은 refresh_token을 사용합니다.
client_id string
client_secret string
Response
200
Header
복사성공! 


1
2
3



HTTP/1.1 200 
Date: Mon, 14 Oct 2019 03:01:27 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4
5
6
7



{
  "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM3MTg1MDU3MzQsInVzZXJfbmFtZSI6IkFMREZBS0sxQjhaUjU2MzE1QzVEIiwianRpIjoiNzcyNWVmNGYtNzc4Yy00NDUyLTk3ZWItODE0NWVmNWIyOTNkIiwiY2xpZW50X2lkIjoic3BlYWtlci5udWd1Lm51MTEwIiwic2NvcGUiOltdLCJleHQiOnsidXNyIjoiQUxERkFLSzFCOFpSNTYzMTVDNUQiLCJkdmMiOiJBTERGRzU1WU1ZUkE5RTUyN0VCRCIsInBvYyI6InNwZWFrZXIubnVndS5udTExMCIsInRrbiI6IjNDNzMxMzEwOUIyQTQ1RTZCQjhBRUQ2MjBGRjNBMThGIn19.pKy2WqIWtKCybQT8jGZsYUyvGg3ZdtQ4zzTSj7IeRYQ",
  "token_type" : "Bearer",
  "refresh_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NzM2MTE4OTksInVzZXJfbmFtZSI6IkFMREZBS0sxQjhaUjU2MzE1QzVEIiwianRpIjoiNjAzYTkyNjUtNTJmNS00ZDE2LWEzOWYtMTVkMGZhM2IxMTgyIiwiY2xpZW50X2lkIjoic3BlYWtlci5udWd1Lm51MTEwIiwic2NvcGUiOltdLCJhdGkiOiI3NzI1ZWY0Zi03NzhjLTQ0NTItOTdlYi04MTQ1ZWY1YjI5M2QiLCJleHQiOnsidXNyIjoiQUxERkFLSzFCOFpSNTYzMTVDNUQiLCJkdmMiOiJBTERGRzU1WU1ZUkE5RTUyN0VCRCIsInBvYyI6InNwZWFrZXIubnVndS5udTExMCIsInRrbiI6IjNDNzMxMzEwOUIyQTQ1RTZCQjhBRUQ2MjBGRjNBMThGIn19.AkXWHMuUlKYKs3wP92roaBWQaFmuW7e4kKmlhmrWDZc",
  "expires_in" : 2147483646,
  "jti" : "7725ef4f-778c-4452-97eb-8145ef5b293d"
}
400
Header
복사성공! 


1
2
3



HTTP/1.1 400 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_grant",
  "error_description": ""
}
401
Header
복사성공! 


1
2
3
4



HTTP/1.1 401 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
WWW-Authenticate: Form realm="NUGU", error="invalid_client", error_description="Bad client credentials"
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_client",
  "error_description": "Bad client credentials"
}

Revoke Endpoint

POST
/v1/auth/oauth/revoke
연결 해제 (Revoke Endpoint)
Parameters
Body
data string
token string
client_id string
client_secret string
Response
200
Header
복사성공! 


1
2
3



HTTP/1.1 200 
Date: Mon, 14 Oct 2019 03:01:27 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1



{}
400
Header
복사성공! 


1
2
3



HTTP/1.1 400 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_token",
  "error_description": ""
}
401
Header
복사성공! 


1
2
3



HTTP/1.1 401 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_client",
  "error_description": ""
}

Introspect Endpoint

POST
/v1/auth/oauth/introspect
연결 조회 (Introspect Endpoint)
Parameters
Body
data string
token string
client:id string
client:secret string
Response
200
Header
복사성공! 


1
2
3



HTTP/1.1 200 
Date: Mon, 14 Oct 2019 03:01:27 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3



{
  "active": true
}
400
Header
복사성공! 


1
2
3



HTTP/1.1 400 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_token",
  "error_description": ""
}
401
Header
복사성공! 


1
2
3



HTTP/1.1 401 
Date: Mon, 14 Oct 2019 04:22:45 GMT
Content-Type: application/json;charset=UTF-8
Body
복사성공! 


1
2
3
4



{
  "error": "invalid_client",
  "error_description": ""
}