me2API 사용설명서

 

요청과 응답

me2API의 요청은 HTTP 요청방식을 사용합니다. GET 또는 POST 메소드를 모두 사용할 수 있습니다.
미투데이 서버로 파라미터를 전달하는 경우 파라미터는 HTML 폼의 기본 인코딩 방식인 application/x-www-form-urlencoded 인코딩을 합니다. 이때 문자열의 인코딩은 UTF-8을 따릅니다.  다만 파일을 업로드하는 경우에는 multipart/form-data 로 인코딩합니다. 

me2API 의 응답은 현재 XML 형식과 JSON 형식을 지원하고 있습니다. 요청시 응답형식을 지정해 선호하는 형식을 사용할 수 있습니다. 응답 형식을 지정하지 않는 경우 XML 형식이 지정됩니다. XML 형식의 응답인 경우 XML 인코딩은 UTF-8을 따릅니다.

 

JSON 형식 호출시 callback 파라미터를 지정하는 경우 지정한 콜백함수을 호출하는 형식으로 결과가 반환됩니다. 즉 다음과 같은 URL로 요청을 한 경우,

    http://me2day.net/api/get_friends/rath.json?callback=my_func

응답 형식은 다음과 같습니다.

    my_func(<JSON 형식의 API 처리 결과>);

 

에러 응답

me2API 요청시 에러가 발생한 발생한 경우 HTTP 상태코드와 응답 본문을 통해 에러를 확인할 수 있습니다.

HTTP 상태코드

me2API 요청시 발생할 수 있는 HTTP 상태코드는 다음과 같습니다.

 

주의) 파이어폭스 3.0.X에서 JSON callback 요청시 무조건 상태코드 200을 반환합니다.

 

응답 본문

응답의 HTTP 상태코드가 500 Internal Server Error 인 경우 발생한 에러의 상세내용을 다음과 같은 형식으로 받아 볼 수 있습니다. 다음 XML형식으로 요청한 경우의 예이며 JSON 형식으로 요청한 경우 같은 내용이 JSON 형식으로 반환됩니다.

 

<error>
  <code>1004</code>
  <message>파라미터가 올바르지 않습니다.</message>
  <description>지정한 사용자를 찾을 수 없습니다.</description>
</error>

 

만약 요청이 정상적으로 처리된 경우 응답 본문은 메소드에 따릅니다.

 

어플리케이션 키

어플리케이션 키는 me2API 를 사용한 어플리케이션을 구분하는 키입니다. me2API를 사용해 어플리케이션을 만드는 경우 미투데이로 부터 어플리케이션 키를 발급 받아 사용해야 합니다. 발급 받은 어플리케이션 키는 모든 me2API 요청시 요청 헤더, 'me2_application_key'에 지정하거나 query string 또는 post body에 인자(파라미터명은 akey)로 지정합니다. 이렇게 지정된 어플리케이션 키는 어플리케이션의 사용량 점검등을 위해 사용됩니다.

다음은 query string 으로 어플리케이션키를 지정해 get_posts 메소드를 호출하는 예입니다.

 

http://me2day.net/api/get_posts/codian?akey=XXXXXXXXXXXXXXXX

 

어플리케이션 키는 발급 받으시려는 분은 어플리케이션키 발급 요청 페이지에서 신청하세요 (로그인하셔야 합니다.)

 

어플리케이션 등급

어플리케이션은 다음과 같이 세 등급으로 구분되며 각 등급에 따라 me2API의 일부 기능이 제한됩니다. 등급별 제공기능은 각 메소드 문서를 확인하세요.

 

me2API 사용자 인증

me2API에서 제공하는 일부 메소드는 사용자 인증이 필요합니다. 사용자 인증은 HTTP Basic Authentication 방식을 사용하거나 query string 또는 post body에 파라미터로 사용자 인증 정보를 지정할 수 있습니다.

 

요청 파라미터로 지정하는 방식의  사용자 인증은 사용자와 인증키를 query string 또는 post body 의 파라미터로 지정해 인증하는 방식입니다. 파라미터 uid 에 미투데이 이름을 지정하고 파라미터 ukey 에 인증키를 지정하여 요청을 보내면 인증을 시도합니다.

 

인증키는 8자리 nonce 문자열과 사용자 키를 붙인 후 md5로 인코딩하고 앞에 다시 nonce 문자열을 붙여 만들어진 문자열입니다.
여기서 nonce는 me2API 어플리케이션 측에서 임의로 생성된 8자리 16진수 문자열입니다.

 

인증키 => nonce + md5(nonce + user_key)

 

me2API 사용자키(user_key)는 미투데이 관리페이지를 통해 확인하거나 다시 생성할 수 있습니다. me2API 사용자키는 me2API를 사용하기 위해 각 사용자에게 발급된 키로 사용자 인증을 위해 사용됩니다. 발급된 사용자키는 미투데이 관리페이지에서 확인할 수 있고 재발급 받을 수도 있습니다.

다음은 query string 에 사용자 정보를 지정하 예입니다.

 

http://me2day.net/api/noop?uid=codian&ukey=XXXXXXXXXXXXXXXX&akey=XXXXXXXXXXXXXXXX

 

HTTP Basic Authentication 방식의 사용자 인증은 사용자와 인증키를 다음과 같이 지정합니다.

username => 미투데이 이름. 예) codian

password => 인증키

 

username 필드는 미투데이에 가입시 등록하여 미투데이 페이지의 URL에 사용하고 있는 미투데이 이름을 지정합니다. password 필드는  me2API 사용자키로 생성한 인증키를 지정합니다. 인증키 생성은 요청 파라미터로 지정하는 방식과 동일합니다. 

 

만약, 웹 기반 쉬운 인증을 사용하시면서 이중 데스크톱 기반 인증 방식을 사용하시고자 하시는 경우, API Key없이 인증할수 있는 방법을 제공하고 있습니다. me2API 웹 기반 쉬운 인증> 데스크톱 어플리케이션 방식 페이지를 참고하시기 바랍니다.

 

me2API 메소드