홈 > 개발가이드 > OAuth2
개요
OAuth는 3rd party를 위한 범용적인 인증 표준입니다.
앱 서비스를 제공하는 제3자가 사용자의 ID, 패스워드 대신 Access Token이라는 것을 얻어서 인증이 필요한 데이터에 접근 할 수 있습니다.
OAuth는 구글, 야후, 트위터, 페이스북 및 국내 네이버, 네이트, 다음 등 주요 인터넷 기업이 사용하는 인증 기술입니다.
요청주소
Request Token 요청 : https://api.ecplaza.net/oauth/requestToken
Access Token 요청 : https://api.ecplaza.net/oauth/accessToken
요청메소드
GET, POST
Request Token 요청변수
| 항목명 |
값 |
설명 |
샘플데이터 |
| client_id |
string (필수) |
발급받은 apikey |
2f4b17d54d3cc4d3c8fcXXXXXXXXXXXXXXXXXXXX |
| client_secret |
string (필수) |
발급받은 apikey secret |
f1510b6813a9721b7716XXXXXXXXXXXXXXXXXXXX |
| redirect_uri |
string (필수) |
결과값을 받을 redirect 경로 |
http://yourdomain.com/api_redirect.php |
| response_type |
string (필수) |
고정 값 (상수) |
code |
Access Token 요청변수
| 항목명 |
값 |
설명 |
샘플데이터 |
| client_id |
string (필수) |
발급받은 apikey |
2f4b17d54d3cc4d3c8fcXXXXXXXXXXXXXXXXXXXX |
| client_secret |
string (필수) |
발급받은 apikey secret |
f1510b6813a9721b7716XXXXXXXXXXXXXXXXXXXX |
| redirect_uri |
string (필수) |
apikey 생성 시 입력한 redirect url |
http://yourdomain.com/api_redirect.php |
| grant_type |
string (필수) |
고정 값 (상수) |
authorization_code |
| code |
string (필수) |
Request Token 요쳥 시 redirect 경로로 전달되는 code |
J9YCtrv7Fy7gE2IZTpB5XXXXXXXXXXXXXXXXXXXX |
출력결과
| 항목명 |
값 |
설명 |
| access_token |
string |
유한한 Access Token |
| token_type |
string |
Token 타입 |
| expires |
integer |
해당 Access Token이 만료되는 시간 |
| expires_in |
integer |
해당 Access Token이 만료되기 까지 남은 시간(초) |
- 결과 예제
{
"access_token" : "TvinT4eYhfdjQm0SLw90XXXXXXXXXXXXXXXXXXXX",
"token_type" : "bearer",
"expires" : 1380617247,
"expires_in" : 3600
}
에러코드
| 에러코드 (error) |
메세지 (error_message) |
설명 |
| unauthorized_client |
The client is not authorized to request an access token using this method. |
인증되지 않은 api |
| invalid_client |
Client authentication failed |
인증 실패 |
| invalid_api_type |
API type is incorrect. Check the api type on the ECPlaza Open API site. |
발급받은 api 종류와 맞지 않는 데이터 요청 |
| no_exist_api |
No exist api. Check the api status on the ECPlaza Open API site. |
존재하지 않는 api |
| exceeded_api_key |
API Key number of requests has been exceeded. Check the api type on the ECPlaza Open API site. |
요청 횟수 만료 |
| invalid_request |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "redirect_uri" parameter. |
잘못된 요청 |
| no_exist_access_token |
Access token is not exist. Check the access token. |
필수요청 파라미터가 없음(access token) |
| expired_token |
The access token is expired. Check the access token. |
access token 만료 |
| query_nothing |
q parameter is required. Check the params. |
검색 관련 파라미터가 없거나 잘못됨 |
