튜토리얼 - Laravel

PHP 개발환경에서 팝빌 SDK를 추가하고, 계좌 거래내역 수집요청 (RequestJob) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

팝빌 PHP SDK를 추가하기 위해 Laravel 프로젝트의 composer.json 파일의 require 필드 오브젝트에 Popbill SDK 정보를 추가후 composer update 커멘드를 실행하여 popbill 패키지를 설치합니다.

 {
   "name" : "laravel/laravel" ,
   "type" : "project" ,
   "description" : "The Laravel Framework." ,
   "keywords" : [
     "framework" ,
     "laravel"
   ],
   "license" : "MIT" ,
   "require" : {
     "php" : "^7.1.3" ,
     "fideloper/proxy" : "^4.0" ,
     "laravel/framework" : "5.7.*" ,
     "laravel/tinker" : "^1.0" ,
     "linkhub/popbill" : "^1.68.2"
   },
   // 생략..

2. POPBiLL SDK 설정

팝빌 SDK의 환경설정을 위해 laravel 프로젝트 config 폴더에 popbill.php 파일을 추가합니다.

<?php
return [
  // API Key
  // - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)
  // • LinkID: 파트너를 식별하기 위한 고유 식별자
  // • SecretKey: API 인증토큰 발급에 사용되는 키
  //
  // TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.
  'LinkID' => 'TESTER',
  'SecretKey' => 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=',

  // 통신방식 기본은 CURL , PHP curl 모듈 사용에 문제가 있을 경우 STREAM 기재가능.
  // STREAM 사용시에는 php.ini의 allow_url_fopen = on 으로 설정해야함.
  'LINKHUB_COMM_MODE' => 'CURL',

  // 연동환경(테스트/운영) 설정
  // - 연동환경을 테스트 또는 운영으로 설정합니다.
  // • true: 테스트 환경으로 설정
  // • false(default) : 운영 환경으로 설정
  //
  // ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게  환경 전환(테스트<->운영)이 가능합니다.
  'IsTest' => true,

  // 인증토큰 IP 일치 검증 사용 여부
  // - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
  //   (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
  // • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용
  // • false(미사용) : IP 일치 검사를 생략
  //
  // ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
  //   예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
  'IPRestrictOnOff' => true,

  // 통신 IP 고정 여부
  // - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
  // • true(사용) : 고정(Static) IP 사용
  // • false(미사용, default) : 가변(Elastic) IP 사용
  //
  // ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
  //   (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
  'UseStaticIP' => false,

  // 로컬시스템 시간 사용 여부
  // - 현재시각 기준을 설정합니다.
  // • true(사용, default) : 로컬시스템 시간 사용
  // • false(미사용) : 팝빌 서버의 시간을 사용
  //
  // ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.
  // ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.
  // ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나
  //   서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.
  'UseLocalTimeYN' => true,
];

Window 계열 OS 환경에서 APM을 통해 개발환경을 구성한 경우 LINKHUB_COMM_MODE 상수의 값을 “STREAM”으로 변경합니다.

3. RequestJob 기능 구현

Controller를 추가하고 클래스 생성자(__construct)에 팝빌 서비스 클래스 초기화 코드와 RequestJob 함수를 추가합니다.

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Linkhub\LinkhubException;
use Linkhub\Popbill\JoinForm;
use Linkhub\Popbill\CorpInfo;
use Linkhub\Popbill\ContactInfo;
use Linkhub\Popbill\ChargeInfo;
use Linkhub\Popbill\PopbillException;

use Linkhub\Popbill\PopbillEasyFinBank;

class TestController extends Controller
{
    public function __construct() {

        // 통신방식 설정
        define('LINKHUB_COMM_MODE', config('popbill.LINKHUB_COMM_MODE'));

        // 계좌조회 서비스 클래스 초기화
        $this->TPopbillEasyFinBank = new PopbillEasyFinBank(config('popbill.LinkID'), config('popbill.SecretKey'));

        // 연동환경(테스트/운영) 설정
        // - 연동환경을 테스트 또는 운영으로 설정합니다.
        // • true: 테스트 환경으로 설정
        // • false(default) : 운영 환경으로 설정
        //
        // ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게  환경 전환(테스트<->운영)이 가능합니다.
        $this->TPopbillEasyFinBank->IsTest(config('popbill.IsTest'));

        // 인증토큰 IP 일치 검증 사용 여부
        // - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
        //   (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
        // • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용
        // • false(미사용) : IP 일치 검사를 생략
        //
        // ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
        //   예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
        $this->TPopbillEasyFinBank->IPRestrictOnOff(config('popbill.IPRestrictOnOff'));

        // 통신 IP 고정 여부
        // - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
        // • true(사용) : 고정(Static) IP 사용
        // • false(미사용, default) : 가변(Elastic) IP 사용
        //
        // ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
        // (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
        $this->TPopbillEasyFinBank->UseStaticIP(config('popbill.UseStaticIP'));

        // 로컬시스템 시간 사용 여부
        // - 현재시각 기준을 설정합니다.
        // • true(사용, default) : 로컬시스템 시간 사용
        // • false(미사용) : 팝빌 서버의 시간을 사용
        //
        // ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.
        // ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.
        // ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나
        //   서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.
        $this->TPopbillEasyFinBank->UseLocalTimeYN(config('popbill.UseLocalTimeYN'));
    }

    /*
     * 계좌 거래내역 수집을 요청한다.
     * - 검색기간은 현재일 기준 90일 이내로만 요청할 수 있다.
     * - 수집 요청후 반환받은 작업아이디(JobID)의 유효시간은 1시간 입니다.
     */
    public function RequestJob(){
        // 팝빌회원 사업자번호, '-'제외 10자리
        $testCorpNum = '1234567890';

        // 기관코드
        $BankCode = '0048';

        // 은행 계좌번호, '-'제외
        $AccountNumber = '3011599770921';

        // 시작일자, 형식(yyyyMMdd)
        $SDate = '20250201';

        // 종료일자, 형식(yyyyMMdd)
        $EDate = '20250228';

        // 팝빌회원 아이디
        $UserID = 'testkorea';

        try {
            $jobID = $this->TPopbillEasyFinBank->RequestJob($testCorpNum, $BankCode, $AccountNumber, $SDate, $EDate, $UserID);
        }
        catch(PopbillException $pe) {
            $code = $pe->getCode();
            $message = $pe->getMessage();
            return view('RequestJob', ['code' => $code, 'message' => $message, 'value' => 'error']);
        }
        return view('RequestJob', [ 'value' => $jobID]);
    }
}

계좌 거래내역 수집요청 작업아이디를 출력하는 페이지(RequestJob.blade.php)를 resources/views/에 추가합니다.

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title>Popbill PHP Laravel Response.</title>
</head>
<body>
    <div>
        <p>Response</p>
        <br>
        <fieldset>
            <ul>
                @if ( $value != "error" )
                    <li>작업아이디(jobID) :  {{ $value }}</li>
                @else
                    <li>오류 코드(code) :  {{ $code }}</li>
                    <li>오류 메시지(message) :  {{ $message }}</li>
                @endif
            </ul>
        </fieldset>
    </div>
</body>
</html>

아래 코드를 참고하여 routes/web.php 파일에 route 부분을 입력합니다.

<?php
// 생략..

Route::get('/RequestJob ', 'TestController@RequestJob');

// 생략..

4. API 응답결과 확인

API 호출 응답결과는 다음과 같습니다.

구분	응답
성공	JobID(작업아이디) : 18자리 문자열
실패	code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지