인크루트 내일검색 공식블로그 :: 내일검색 OpenAPI 용 PHP 예제

내일검색 OpenAPI 용 PHP 예제

from 오픈 API 2008/08/03 22:03

안녕하세요? 내일검색 웹마스터입니다.

내일검색은 OpenAPI를 통해 사이트의 기능 확장을 도와드리고 있습니다. OpenAPI를 사용할 수 있다면 자신의 사이트에 내일검색의 기능을 넣을 수 있습니다. 이 중에서 PHP 언어를 이용한 OpenAPI 중 채용검색 API를 보여드리려고 합니다. 채용검색 API를 하실 수 있다면 인기검색어 API는 그리 어렵지 않습니다.

OpenAPI를 사용하기 위해서는 다음과 같은 준비물이 필요합니다.

- PHP 4 혹은 PHP 5
- UTF-8(유니코드)가 지원되는 텍스트 에디터

내일검색의 검색결과는 유니코드로 출력이 되기 때문에, API의 사용도 유니코드로 해주셔야 글씨가 깨지지 않습니다. 메모장에서는 다음과 같이 저장하시면 됩니다(Windows XP 이상).

유니코드, 유니코드(Big Endian), ANSI, UTF-8 중에 UTF-8로 해주시면 됩니다. 다른 텍스트에디터에서도 UTF-8로 저장해주시면 됩니다. UTF-8이 지원되지 않는 텍스트에디터는 사용할 수 없습니다.

첨부파일을 보시면, 4개의 파일이 있는데 간단하게 그 역할을 소개하겠습니다.

- style.css : 스타일시트 파일입니다. 검색 결과 부분에서의 모양새를 결정할 수 있습니다.
- index.php : 검색 초기 화면입니다. 직접 사용하실 때에는 각 사이트별로 달라질 수 있습니다.
- search.php : 검색 결과를 출력하는 파일입니다. simplexml.php와 연결되어있으며, XML로 넘어오는 검색 결과를 적절하게 파싱해서 출력합니다.
- simplexml.php : 간단한 XML 파서입니다.

그렇다면 index.php 부터 살펴보겠습니다.

<html>
<head>
    <title>내일 검색 오픈API 예제</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body style="text-align:center">
    <h2>내일검색 OpenAPI 예제</h2>
    <!-- 이부분 부터는 검색에 관한 부분입니다. form부터 /form까지입니다 -->
    <form action="./search.php" method="GET">
        <input type="text" name="query">
        <input type="submit" value="검색">
        <hr/>
        <label for="category">
    </form>
</body>
</form>

우선 meta 태그를 이용해서 문자셋을 UTF-8로 해줍니다. 웹 브라우저가 "이 문서는 UTF-8 형식이군" 이라고 알아차리기 위해서입니다. 보통 euc-kr도 많이 사용합니다만, 내일검색의 검색결과가 UTF-8로 나오기 때문에 UTF-8로 해주셔야 합니다(검색 질의에서 코드가 안맞으면 한국어로 검색이 되지 않습니다).

form 태그의 action이 search.php로 가있으니 이 질의는 search.php로 넘어갈 것입니다. method는 GET 방식인데, 검색엔진에서는 개인정보를 특별하게 노출 할 것이 없으므로 POST 방식을 사용하지 않았습니다. POST 방식을 사용하는 경우 search.php의 변수 부분 중 $_GET를 $_POST로 변경해 주셔야 합니다.

index.php는 매우 단순하니 이정도로 보고 넘어가서, 중요한 파일인 search.php를 살펴보도록 하겠습니다.

search.php는 크게 두 부분으로 나뉘어져 있습니다. 첫 번째 부분은 내일검색 OpenAPI 서버에 접속해서 검색질의어에 해당하는 검색 결과를 XML로 가져오는 부분이며, 두 번째 부분은 simplexml.php가 파싱한 구조화된 데이터를 적절하게 화면에 보여주는 부분입니다. 우선 내일검색 OpenAPI 서버에 접속하여 질의 결과를 가져오도록 하겠습니다.

<?php
    // OpenAPI Example for PHP4, 5
    // PHP5에서 실행하기를 권합니다.
    
    require_once "simplexml.php";

    // 오픈API 키가 있어야 검색을 할 수 있습니다. 키는 내일검색에서 받으 실 수 있습니다.
    $apikey = "여러분의 API Key를 입력하세요";
    
    // 검색페이지에서 입력한 검색질의어입니다.
    $user_query = $_GET['query'];

    // HTTP Query 하기 위한 준비 과정
    $host = "www.incruit.com";
    $port = 80;
    $timeout = 30; // 30초가 지나도록 반응이 없으면 시간초과에러가 납니다

    // 내일검색 옵션
    $out = "xml"; // json, rss, xml

    // 동시에 보이는 검색 결과 수 (기본값 10)
    if (!$_GET['count'])
    {
        $_GET['count'] = 10;
        $count = $_GET['count'];
    }

    // 시작번호 기본값 지정
    if (!$_GET['page']) // 페이지가 안 정해져있으면, 시작위치는 0으로 한다.
    {
        $_GET['page'] = 1;
        $start = ($_GET['page'] - 1) * $_GET['count']; // (페이지-1) * 동시에 보이는 결과
    }
    else
    {
        $start = ($_GET['page'] - 1) * $_GET['count']; // (페이지-1) * 동시에 보이는 결과
    }

    $query = "?apikey={$apikey}&method=search&q={$user_query}&start={$start}&count={$count}&out=xml";

    // HTTP Socket 연결
    $socket = fsockopen('naeilapi.incruit.com', $port, $errno, $errstr, $timeout);

    if (!$socket) {
        echo "$errstr ($errno)<br />\n";
    }
    else
    {
        $out = "GET /api/";
        $out .= $query;
        $out .= " HTTP/1.1\r\n";
        $out .= "Host: naeilapi.incruit.com\r\n";
        $out .= "Connection: Close\r\n\r\n";

        fwrite($socket, $out);
    }

    // 헤더 읽기.
    $api_header = '';
    while (!feof($socket))
    {
        $out = fgets($socket,512);
        if (trim($out) == '') {
            break;
        }
        $api_header .= $out;
    }

    // 본문 읽기.
    $api_body = '';
    while (!feof($socket))
    {
        $out = fgets($socket,512);
        $api_body .= $out;
    }
    
    $idx = strpos(strtolower($api_header), 'transfer-encoding: chunked');

    if ($idx > -1) {
        $temp = '';
        $offset = 0;
        do {
            $idx1 = strpos($api_body, "\r\n", $offset);
            $chunkLength = hexdec(substr($api_body, $offset, $idx1 - $offset));

            if ($chunkLength == 0) {
                break;
            }
            else
            {
                $temp .= substr($api_body, $idx1 + 2, $chunkLength);
                $offset = $idx1 + $chunkLength + 4;
            }
        }while (true);
        $api_body = $temp;
    }

    fclose($socket); // 접속 종료.

index.php에 비해서 매우 길지만, 차근차근 살펴보겠습니다. 우선 가장 중요한 것은 $apikey 부분입니다. OpenAPI는 API 키를 받아서 사용하도록 되어있습니다. API Key의 발급은 이곳에서 하시면 됩니다.
동시에 보이는 검색결과수가 있는데, 한 화면에 몇 건의 채용 정보가 표시 될지를 정하는 부분입니다. 기본값은 10이며, 원하시는 대로 조절하실 수 있습니다. 그리고 $query를 잘 보시기 바랍니다.

$query = "?apikey={$apikey}&method=search&q={$user_query}&start={$start}&count={$count}&out=xml";

apikey(API키)가 들어갔고, method는 search(키워드 검색이며 실시간 인기검색어와 자체 시험인 echo가 있습니다)가 들어갔습니다. q는 사용자가 넣은 키워드가 들어가며, start는 몇 번째 채용정보 부터 보여줄 것인지를 결정합니다. count는 앞서 설명드린 대로 한 화면에 보여질 채용정보의 수이며, out은 출력 방식입니다. 이 파일에서는 XML로 작업합니다(JSON 방식이 있습니다).

또한 이 파일은 REST 방식으로 데이터를 받아오는데, API 사이트와의 소켓 연결을 통해서 HTTP 데이터를 직접 받아옴을 뜻합니다. 그 이후 부분은 받아온 HTTP 데이터를 가공하여 simplexml이 읽을 수 있도록 만드는 과정이라고 보시면 됩니다. fclose 함수를 통해 소켓 연결을 종료하면서 첫 번째 부분은 끝이 납니다.

두 번째 부분을 설명하기 앞서, simplexml.php 부터 보도록 하겠습니다. 다음은 소스입니다.

<?php
    class exXML {
        var $totalCount;             // 해당 공고 수
        var $vals = null;
        var $currTag;
        var $is_item;
        var $rec_num = 0;
        
        function exXML () {
        }

        function parse($data) {
            $this->parser = xml_parser_create();

            xml_set_object($this->parser, $this);
            xml_set_element_handler($this->parser, 'tagOpen', 'tagClose');
            xml_set_character_data_handler($this->parser, 'cdata');

            if (!xml_parse($this->parser, $data)) {
                echo "XML Parsing Error!";
            }
            
            xml_parser_free($this->parser);

            return true;
        }

        function tagOpen($parser, $tag, $attr)
        {
            global $is_item;
            global $rec_num;
            // 현재 어떠한 태그를 파싱하고 있는지 저장합니다.
            // 내일검색의 데이터는 모두 CDATA 방식이기에 여기에서 바로 파싱이 되지 않습니다.

            $this->currTag = strtolower($tag); // 대문자로 된 태그를 소문자로 일괄 변환합니다.

            // item(검색 결과의 시작인 경우)
            if ($this->currTag == "item"  && $is_item == 0) {
                $is_item = 1;
                $rec_num++;
            }
        }

        function tagClose($parser, $tag)
        {
            global $rec_num;
            global $is_item;


            $tag = strtolower($tag);
            if ($tag == "item") {
                $is_item = 0;
            }
        }

        function cdata($parser, $tag)
        {
            global $rec_num;
            global $vals;
            global $is_item;

            // 공고의 총 갯수를 구합니다.
            if ($this->currTag == "totalcount") {
                $this->totalCount = $tag;
            }
            // 공고 내용을 배열에 저장합니다.
            if ($is_item == 1) {
                switch ($this->currTag) {
                    case "job_title":
                        $vals[$rec_num]['title'] .= $tag;
                        break;
                    case "employ_ty_nm":
                        $vals[$rec_num]['employType'] .= $tag;
                        break;
                    case "comp_nm":
                        $vals[$rec_num]['comp'] .= $tag;
                        break;
                    case "region_nm":
                        $vals[$rec_num]['region'] .= $tag;
                        break;
                    case "region_det_nm":
                        $vals[$rec_num]['region_det'] .= $tag;
                        break;
                    case "subway_str":
                        $vals[$rec_num]['subway'] .= $tag;
                        break;
                    case "schol_nm":
                        $vals[$rec_num]['degree'] .= $tag;
                        break;
                    case "career_nm":
                        $vals[$rec_num]['career'] .= $tag;
                        break;
                    case "salary_nm":
                        $vals[$rec_num]['salary'] .= $tag;
                        break;
                    case "c_addr_str":
                        $vals[$rec_num]['addr'] .= $tag;
                        break;
                    case "job_cont":
                        $vals[$rec_num]['jobcont'] .= $tag;
                        break;
                    case "cl_invite_start_dt":
                        $vals[$rec_num]['startDate'] .= $tag;
                        break;
                    case "cl_invite_close_dt":
                        $vals[$rec_num]['endDate'] .= $tag;
                        break;
                    case "employ_limit":
                        $vals[$rec_num]['limit'] .= $tag;
                        break;
                    case "source_site_nm":
                        $vals[$rec_num]['source'] .= $tag;
                        break;
                    case "source_site_url":
                        $vals[$rec_num]['sourceUrl'] .= $tag;
                        break;
                    case "link_url":
                        $vals[$rec_num]['linkUrl'] .= $tag;
                        break;
                    case "cl_date":
                        $vals[$rec_num]['addDate'] .= $tag;
                        break;
                }
            }
        }

        function display()
        {
            global $vals;
            return $vals;
        }

    }
?>

simplexml은 검색결과를 화면에 출력할 수 있도록 구조화시켜주는 역할을 합니다. 일종의 문자인식기라고 보시면 되겠습니다.

검색결과 XML에는 일정한 순서와 패턴이 존재하기 때문에 이 패턴을 알면 많은 데이터를 틀리지 않게 분류해서 저장할 수 있습니다. 검색 결과는 매 건이 ITEM 태그로 시작해서 ITEM 태그로 끝납니다. 이것을 프로그램이 잡아내서 각 항목별로 자료를 넣어줍니다. 자세한 xml 파싱용 함수에 대해서는 php 관련 문서를 참조해주세요^^

case 문으로 채워진 부분은 내일검색 API 검색 결과에서 나오는 모든 항목을 정리해주는 부분입니다.

function display()는 차곡차곡 정리한 결과를 얻어올 때 사용합니다. 누가 얻어올까요? search.php가 다시 얻어옵니다. 이제 search.php의 두 번째 부분으로 넘어가겠습니다.

    $p = new exXML();
    $p->parse($api_body);

    // 결과를 가공하기 위해 배열을 가져옵니다.
    $showdata = $p->display();
    $totalCount = $p->totalCount;
?>

<?php
    // 이부분부터는 실제로 검색결과가 출력되는 부분입니다.
    // 따로 스킨으로 처리해서 완전히 분리할 수도 있습니다.
?>

<html>
<head>
<title><?=$_GET['query'] ?>    에 대한 검색 결과 </title>
<link rel="stylesheet" href="./style.css" type="text/css" />
</head>
<body>
<div id="page">
    <div id="searchForm">
        <form action="./search.php" method="GET">
            내일검색 <input type="text" name="query">
            <input type="submit" value="검색">
            <hr/>
            <label for="category">
        </form>
    </div>
    <div id="statics">
        <p class="totalcount"><b><?=$_GET['query'] ?></b>에 대해 총 <?=$p->totalCount ?> 건의 채용 정보가 검색되었습니다.</p>
        <?
            $view_start = $start +1;
            if ($count > $p->totalCount) {
                $view_end = $p->totalCount;
            }
            else
            {
                $view_end = $start + $count;
            }
        ?>
        <p class="currentpage">현재 <?=$view_start ?>번 부터 <?=$view_end ?>번 까지 보고 있습니다.</p>
    </div>
    <div id="result">
    <?
        foreach ($showdata as $key => $value)
        {
            echo "<p class='title'><b>".$value['comp']."</b> - "."<a href='".$value['linkUrl']."'>".$value['title']."</a></p>";
            echo "<p class='subinfo'>";
            if ($value['region_det'] != "")
            {
                echo $value['region_det']." | ";
            }
            if ($value['employType'] != "")
            {
                echo $value['employType']. " | ";
            }
            if ($value['career'] != "")
            {
                echo $value['career']." | ";
            }
            if ($value['salary'] != "")
            {
                echo $value['salary']." | ";
            }
            if ($value['startDate'] != 0)
            {
                $temp_year = substr($value['startDate'], 0, 4);
                $temp_month = substr($value['startDate'], 4, 2);
                $temp_day = substr($value['startDate'], 6, 2);

                echo $temp_year."/".$temp_month."/".$temp_day." ~ ";
            }
            else
            {
                echo " ~ ";
            }

            if ($value['endDate'] != 0)
            {
                $temp_year = substr($value['endDate'], 0, 4);
                $temp_month = substr($value['endDate'], 4, 2);
                $temp_day = substr($value['endDate'], 6, 2);
                
                echo $temp_year."/".$temp_month."/".$temp_day." | ";
            }
            else
            {
                echo " | ";
            }

            if ($value['limit'] != "")
            {
                echo $value['limit']." | ";
            }
        }

    ?>
    </div>
    <div id="pageBrower">
    <?
        // 페이지를 보여주는 부분

        // 시작점을 정해줍니다.
        $p_start = (int) ($page / 10); // 페이지 번호를 10개씩 보여주기 위해 10을 나눠줍니다.

        // 10페이지 이후를 보고 있는 경우 앞으로 돌아가는 링크를 만듭니다.
        if ($p_start != 0)
        {
            $p = ($p_start) * 10 - 1;

            $url = "search.php";
            $url .= "?query={$user_query}&page={$p}&count={$count}";

            echo "<a href='{$url}'>◀</a>";
        }

        // 페이지 번호가 나오는 부분입니다.
        for ($i=1;$i < 11;$i++)
        {
            $p = $p_start * 10 + $i;

            if (($p * 10) < $totalCount)
            {
                if ($p != $page)
                {
                    $url = "search.php";
                    $url .= "?query={$user_query}&page={$p}&count={$count}";

                    echo "[<a href='{$url}'>".$p."</a>]";
                }
                else
                {
                    echo "[{$p}]";
                }
            }
        }
        
        // 검색결과가 현재 페이지 번호들이 표현할 수 있는 번호보다 큰 경우 이후의 번호가 나올 수 있게 링크를 겁니다.
        if ($p * 10 < $totalCount)
        {
            $p++;

            $url = "search.php";
            $url .= "?query={$user_query}&page={$p}&count={$count}";

            echo "<a href='{$url}'>▶</a>";
        }
    ?>
    </div>
</div>
</body>
</html>

HTML과 PHP가 같이 있습니다. 검색 결과를 실제로 화면에 출력하기 때문에 그렇습니다. simplexml에서 정리한 데이터를 순서대로 출력해주는 부분입니다. 그리고 페이지 번호를 적절하게 보여주는 기능도 넣었습니다.

지금까지 PHP를 이용하여 내일검색 키워드 검색 API를 사용하는 방법을 알아보았습니다. 예제가 완벽하진 않지만 충분히 도움이 되었으리라 믿어 의심치 않습니다^^;; 참고 사이트와 첨부파일을 덧붙이면서 이 긴 글(?)을 마치겠습니다.

참고사이트

BENEGLO BLOG : 네이버의 OpenAPI를 PHP로 만드는 방법을 소개하신 페이지입니다.
http://kr.php.net/manual/en/book.xml.php : PHP 공식 사이트입니다. XML에 관련된 부분은 대개 영어로 되어있습니다.

첨부파일

naeil_openapi_for_php.zip