이미지 검색 API
이미지 검색 API는 모든 이미지 서비스에 대한 검색 결과를 외부 개발자 및 사용자에게 RSS,JSON,XML 형식으로 전달하는 API 서비스입니다. 이미지의 유용한 정보를 자신의 블로그나 자사 웹 서비스에 제공할 수 있게 해 줍니다.
요청 주소(Request URL) #
- http://apis.daum.net/search/image
요청 변수 (Request Parameters) #
- 공통 인증 변수: 모든 API 서비스 요청시 공통적으로 넣어야 할 변수는 아래와 같습니다.
인증 파라미터 #
- 인증에 사용되는 공통 파라미터를 설명합니다.
| 요청 변수 | 값 | 설명 |
| apikey | 40 byte hexadecimal string (필수) | 모든 오픈 API 호출에 공통으로 사용되는 인증키 입니다. Daum 회원이면, apikey를 발급 받을 수 있습니다. 오픈 API는 검색, UCC, 디앤샵 API로 구분됩니다. 나중에 다른 API가 추가될 수 도 있습니다. 각 API별로 Daum 회원은 하나의 apikey 만을 발급받을 수 있습니다. 그리고, 이 apikey로는 허가된 API만 호출 할 수 있습니다. 예) apikey=4125603e35da5d8820b07dc7b19050dbc838336b |
| apid | 20 byte hexadecimal string | 오픈 API를 이용하여 어플리케이션 이나 웹 사이트를 작성한 개발자 분들은 프로그램 등록을 할 수 있습니다. apid 는 등록된 프로그램에 대해서 오픈 API 인증 시스템에서 제공한 프로그램 아이디 입니다. 일부 오픈 API는 apid 파라미터를 필수로 요구하는 경우가 있습니다. 등록된 프로그램은 이 DNA 사이트를 통해서 홍보되며, 개발자 본인의 의사에 따라 다른 사용자가 다운받아 설치할 수 있게 됩니다. 예) apid=ba8c53ab7970189d93a7 |
서명 인증 파라미터 #
- 서명된 오픈 API는 인증키가 다른 사용자에 의해서 도용 되는 것을 보호해 줍니다.
- 서명은 필수적인 파라미터가 아닙니다. 그러나, 일부 오픈 API는 반드시 서명을 요구합니다.
- 서명에 사용되는 파라미터를 설명합니다.
| 이름 | 값 | 설명 |
| ts | YYYYMMDDhhmmss | 오픈 API를 호출하는 시간. UTC Time 으로 변환되서 전달되어야 합니다. 서명 값(sig)을 전달할 때 반드시 포함되어야 합니다. 예, ts=20060501153010 |
| nonce | 16 byte hexadecimal string | 랜덤한 8byte binary 값. ts 와 함께 서명의 재 사용여부를 확인하는데 사용됩니다. 서명 값(sig)을 전달할 때 반드시 포함되어야 합니다. 예, nonce=bd149ae021feb132 |
| sigalg | "hmacsha1" | 서명에 사용하는 알고리즘 이름. "hmacsha1" 으로 고정되어 있습니다. 실제 사용하는 알고리즘은 RFC 2014 에 정의되어 있는 HMACSHA-1 입니다. 서명 값(sig)을 전달할 때 반드시 포함되어야 합니다. |
| sig | 40 byte hexadecimal string | 오픈 API 호출 URL 전체에 대해서 서명키로 서명한 값. 예) sig=b45de8a31aed6e58b831dd72087bb4ed71fcaf98 |
- 서명 값 만들기 & 소스 예제 코드 : HowToSign
- 서비스 인증 변수: 본 서비스에서 사용되는 변수는 아래와 같습니다.
| 요청 변수 | 값 | 설명 |
| q | string (필수) | 검색을 원하는 질의 |
| result | integer : 기본값 10, 최소 1, 최대 20 | 한 페이지에 출력될 결과수 |
| pageno | integer : 기본값 1, 최소 1, 최대 500 | 검색 결과 페이지 번호 |
| sort | integer : 기본값 1, 최소 0, 최대 1 | 0:최신순 1:정확도순 |
| output | string : json(기본값), xml, json | 결과형식 |
- 샘플 URL
출력 방식 (Response Method) #
- RSS방식으로 제공 가능합니다.
- JSON방식으로 제공 가능합니다.
- XML방식으로 제공 가능합니다.
출력 결과 (Response Elements) #
- 출력 결과
| 출력 변수 | 값 | 설명 |
| title | string | 검색 제목 |
| desc | string | 검색 결과의 간략한 소개 |
| totalCount | integer | 전체 검색 결과의 수 |
| sort | string | 검색 결과의 정렬순 |
| result | integer | 한 페이지에 보여질 결과 수 |
| pageno | integer | 검색 결과의 페이지 번호 |
| q | string | 검색어 |
| item | - | 개별 검색 결과 정보 |
| author | string | 작성자 |
| title | string | 개별 검색 결과의 제목 |
| link | string | 개별 검색 결과의 link url |
| image | string | 이미지 URL |
| thumbnail | string | 썸네일 URL |
| width | string | 이미지의 가로 크기 |
| height | string | 이미지의 세로 크기 |
| description | string | 개별 검색 결과의 본문 요약 |
| pubDate | string | 등록일 |
| cp | integer | cp번호 (0:플래닛 1:영화 4:텔레비존 5:아고라 6:뉴스 7:블로그 8:파이 9:스포츠 10:신지식 12:한국컨텐츠진흥원(문화원형사전) 13:시티엔 15:카페) |
출력 결과 샘플 페이지 #
* JSON 출력 결과
{
"channel":{
"item":[{
"thumbnail":"http://img.search.hanmail.net/imgthum/00/85/0/PA_160904_1882904.jpg",
"width":"800",
"cp":"8",
"height":"600",
"title":"베트남 남부..까페(베트남 사업도우미)cafe.daum.net/limchul333",
"description":"<img src="http://img.search.hanmail.net/imgthum/00/85/0/PA_160904_1882904.jpg">... 사업도우미)cafe.<b>daum</b>.net/...",
"image":"http://cfs2.pie.daum.net:80/1%2FLzAvOC8xNi83Mg%24%24%2Fdaumpie.jpg",
"pubDate":"20061009195501",
"link":"http://pie.daum.net/p160904i1882904",
"author":"limchul1234"},
{
"thumbnail":"http://img.search.hanmail.net/imgthum/00/dd/b/PA_130008_1457023.jpg",
"width":"550",
"cp":"8",
"height":"550",
"title":"스타들의웨딩사진(http://cafe.daum.net/fallingmakeup)",
"description":"<img src="http://img.search.hanmail.net/imgthum/00/dd/b/PA_130008_1457023.jpg">스타들의웨딩사진(http://cafe.<b>daum</b>.net/fallingmakeup)",
"image":"http://cfs3.pie.daum.net:80/6%2FLzAvMTAvMjAvOTQ%24%2Fdaumpie.jpg",
"pubDate":"20061105155154",
"link":"http://pie.daum.net/p130008i1457023",
"author":"tnswls0830"}],
"sort":"1",
"title":"Search image Daum Open API",
"result":"2",
"totalCount":408,
"q":"daum",
"pageno":"1",
"desc":"Daum Open API search result"
}
}
* RSS 출력 결과
<?xml version="1.0" encoding="UTF-8" ?> <rss version="2.0"> <channel> <title> Daum Open API - image Search - query : 'daum'</title> <link>http://apis.daum.net/search/image</link> <description>Daum Open API search result</description> <lastBuildDate>Thu, 08 Feb 2007 14:37:28 +0900</lastBuildDate> <generator>Daum Open API :: Search - image</generator> <totalCount>408</totalCount> <sort>1</sort> <result>2</result> <pageno>1</pageno> <q>daum</q> <item> <author>limchul1234</author> <title>베트남 남부..까페(베트남 사업도우미)cafe.daum.net/limchul333</title> <link>http://pie.daum.net/p160904i1882904</link> <image> <url>http://cfs2.pie.daum.net:80/1%2FLzAvOC8xNi83Mg%24%24%2Fdaumpie.jpg</url> </image> <thumbnail>http://img.search.hanmail.net/imgthum/00/85/0/PA_160904_1882904.jpg</thumbnail> <width>800</width> <height>600</height> <description><img src="http://img.search.hanmail.net/imgthum/00/85/0/PA_160904_1882904.jpg">... 사업도우미)cafe.<b>daum</b>.net/...</description> <pubDate>Mon, 09 Oct 2006 19:55:01 +0900</pubDate> <cp>8</cp> </item> <item> <author>tnswls0830</author> <title>스타들의웨딩사진(http://cafe.daum.net/fallingmakeup)</title> <link>http://pie.daum.net/p130008i1457023</link> <image> <url>http://cfs3.pie.daum.net:80/6%2FLzAvMTAvMjAvOTQ%24%2Fdaumpie.jpg</url> </image> <thumbnail>http://img.search.hanmail.net/imgthum/00/dd/b/PA_130008_1457023.jpg</thumbnail> <width>550</width> <height>550</height> <description><img src="http://img.search.hanmail.net/imgthum/00/dd/b/PA_130008_1457023.jpg">스타들의웨딩사진(http://cafe.<b>daum</b>.net/fallingmakeup)</description> <pubDate>Sun, 05 Nov 2006 15:51:54 +0900</pubDate> <cp>8</cp> </item> </channel> </rss>* XML 출력 결과
<?xml version="1.0" encoding="UTF-8" ?> <channel> <title>Search image Daum Open API</title> <desc>Daum Open API search result</desc> <totalCount>408</totalCount> <sort>1</sort> <result>2</result> <pageno>1</pageno> <q>daum</q> <item> <author>limchul1234</author> <title>베트남 남부..까페(베트남 사업도우미)cafe.daum.net/limchul333</title> <link>http://pie.daum.net/p160904i1882904</link> <image>http://cfs2.pie.daum.net:80/1%2FLzAvOC8xNi83Mg%24%24%2Fdaumpie.jpg</image> <thumbnail>http://img.search.hanmail.net/imgthum/00/85/0/PA_160904_1882904.jpg</thumbnail> <width>800</width> <height>600</height> <description><img src="http://img.search.hanmail.net/imgthum/00/85/0/PA_160904_1882904.jpg">... 사업도우미)cafe.<b>daum</b>.net/...</description> <pubDate>20061009195501</pubDate> <cp>8</cp> </item> <item> <author>tnswls0830</author> <title>스타들의웨딩사진(http://cafe.daum.net/fallingmakeup)</title> <link>http://pie.daum.net/p130008i1457023</link> <image>http://cfs3.pie.daum.net:80/6%2FLzAvMTAvMjAvOTQ%24%2Fdaumpie.jpg</image> <thumbnail>http://img.search.hanmail.net/imgthum/00/dd/b/PA_130008_1457023.jpg</thumbnail> <width>550</width> <height>550</height> <description><img src="http://img.search.hanmail.net/imgthum/00/dd/b/PA_130008_1457023.jpg">스타들의웨딩사진(http://cafe.<b>daum</b>.net/fallingmakeup)</description> <pubDate>20061105155154</pubDate> <cp>8</cp> </item> </channel>
오류 메시지 #
- 공통 오류 메시지는 다음과 같습니다.
오류는 다음과 같은 XML로 전달됩니다.
<?xml version="1.0" encoding="UTF-8"?>
<apierror>
<code></code>
<message></message>
<dcode></code>
<dmessage></dmessage>
</apierror>
오류 XML의 각 항목은 아래와 같은 값을 가집니다.
| 오류 코드 (code|dcode) | 오류(message) | 상세 오류(dmessage) | 설명 |
| 10 | | invalid request | 오픈 API 호출이 공통 호출 규약에 맞지 않은 경우에 전달된다. | |
| 10 | 11 | invalid request | apikey missing | apikey 파라미터가 없음 |
| 10 | 12 | invalid request | Missing auth parameter 'ts'. | ts 파라미터가 없음 |
| 10 | 13 | invalid request | Missing auth parameter 'nonce'. | nonce 파라미터가 없음 |
| 10 | 14 | invalid request | Missing auth parameter 'sigalg'. | sigalg 파라미터가 없음 |
| 10 | 15 | invalid request | Missing auth parameter 'sig'. | sig 파라미터가 없음 |
| 10 | 18 | invalid request | Missing parameter 'apid'. | apid 파라미터가 없음 |
| 20 | | unknown ap instance | 프로그램 인증 실패. | |
| 20 | 21 | unknown ap instance | invalid apikey | 유효하지 않은 apikey |
| 20 | 22 | unknown ap instance | unregistered apikey | 등록되지 않은 apikey |
| 20 | 23 | unknown ap instance | unregistered apid | 등록되지 않은 apid |
| 20 | 24 | unknown ap instance | Signature sigkey is not valid. | 유효하지 않은 서명키 |
| 20 | 25 | unknown ap instance | invalid apid | 유효하지 않은 apid |
| 20 | 26 | unknown ap instance | SignatureKey is not issued to this apikey. | apikey 해당하지 않는 서명키 |
| 20 | 27 | unknown ap instance | ts, nonce are reused. | ts,nonce 재사용 오류 |
| 20 | 28 | unknown ap instance | Unsupported Sign Algorithm. | 지원하지 않는 서명 알고리즘 |
| 30 | | unknown daumuser | apikey 소유자의 Daum 인증 실패. | |
| 40 | | access denied | 서비스 접근 거부 | |
| 40 | 41 | access denied | valid api call but traffic overed | 하루 api 호출 traffic 초과 |
| 40 | 42 | access denied | apikey does not match api category | 이 apikey 로 호출할 수 있는 api 가 아님 |
| 40 | 43 | access denied | unsigned call | 서명되지 않은 호출 |
| 40 | 44 | access denied | unregistered ip | 등록되지 않은 IP 주소 |
| 40 | 45 | access denied | apid doesnot use api | 프로그램이 이 api를 사용하고 있지 않음 |
| 404 | no such api | 해당 오픈 API 서비스가 없음 | |
| 500 | system error | 오픈 API 서비스 내부 시스템 에러. | |
| 504 | service timeout | 오픈 API 서비스 연결 실패. 서비스 시스템 과부하 또는 장애로 인한 서비스 연결 실패. | |
| 100 | | service api runtime error | 오픈 API 서비스 실행 오류. 101~299 값을 가지며, 각 API 에서 정의함. |
- 이 서비스의 오류 메시지는 다음과 같습니다.
| 오류 코드(dcode) | 오류 설명(dmessage) |
| 101 : Required parameter | 필수 Parameter를 요청하지 않았습니다. 필수 Parameter 가 dummy일 경우 '...&dummy=&'와 같이 값을 입력하지 않았거나 Parameter를 name자체를 입력하지 않았을 경우에 해당 에러메세지를 발생합니다. |
| 111 : Exceeded maximum value | Parameter의 값이 integer일 경우, 입력된 값이 최대값을 초과하면 해당 에러 메세지를 발생합니다. |
| 112 : Belowed minimum value | Parameter의 값이 integer일 경우, 입력된 값이 최소값의 미만이면 해당 에러 메세지를 발생합니다. |
| 121 : Invalid value | Parameter의 type이 잘못 입력되었습니다. parameter 값이 integer일 경우 string값으로 입력되면 해당 에러 메세지를 발생합니다. |
| 122 : Not allowed value | Parameter에 허용되지 않은 값이 입력되었습니다. Parameter에 제한된 값이 있을 경우 허용되지 않은 값이 입력되면 해당 에러 메세지를 발생합니다. |
| 131 : System error | System의 오류가 있을시 해당 에러 메세지를 발생합니다. |
트래픽 제한 #
- 오픈 API는 하나의 apikey에 대해서 하루 5,000 회의 호출 만을 허용합니다.
- 트래픽 제어는 보안을 위한 측면이 크며, 증가 추이에 따라 트래픽 허용 수를 늘리는 정책을 사용할 예정입니다.
- 상용 서비스를 위해 또는 사용자 증가로 인하여 허용 traffic 수를 늘리고자 할때에는 어플리케이션 등록을 마치고, 해당 apid에 대해 별도로 traffic 을 조정할 수 있습니다.
샘플 코드 #
- PHP 코드
- JavaScript 코드



