튜토리얼

PHP 개발환경에서 팝빌 SDK를 추가하여 팩스 전송 (SendFAX) 함수를 구현하는 예시입니다.

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.63.9"
   },
   // 생략..

2. POPBiLL SDK 설정

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

<?php
return [
  // 링크아이디
  'LinkID' => 'TESTER',

  // 비밀키
  'SecretKey' => 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=',

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

  // 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
  'IsTest' => true,

  // 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true)
  'IPRestrictOnOff' => true,

  // 통신 IP 고정, true-사용, false-미사용, (기본값:false)
  'UseStaticIP' => false,

  // 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
  'UseLocalTimeYN' => true,
];

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

3. SendFAX 기능 구현

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

<?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\PopbillFax;


class TestController extends Controller
{
  public function __construct() {

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

    // 팩스 서비스 클래스 초기화
    $this->PopbillFax = new PopbillFax(config('popbill.LinkID'), config('popbill.SecretKey'));

    // 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
    $this->PopbillFax->IsTest(config('popbill.IsTest'));

    // 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true)
    $this->PopbillFax->IPRestrictOnOff(config('popbill.IPRestrictOnOff'));

    // 통신 IP 고정, true-사용, false-미사용, (기본값:false)
    $this->PopbillFax->UseStaticIP(config('popbill.UseStaticIP'));

    // 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
    $this->PopbillFax->UseLocalTimeYN(config('popbill.UseLocalTimeYN'));
  }

  public function SendFAX(){

    // 팝빌 회원 사업자번호
    $testCorpNum = '1234567890';

    // 팩스전송 발신번호
    $Sender = '07043042992';

    // 팩스 수신정보 배열, 최대 1,000건
    $Receivers[] = array(
        // 팩스 수신번호
        'rcv' => '070111222',
        // 수신자명
        'rcvnm' => '팝빌담당자'
    );

    // 팩스전송 파일경로, 해당파일에 읽기 권한이 설정되어 있어야 함. 최대 20개.
    $FilePaths = array('/Users/John/Desktop/tax_image.png');

    // 예약전송일시(yyyyMMddHHmmss) ex) 20151212230000, null인경우 즉시전송
    $reserveDT = null;

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

     // 팩스전송 발신자명
    $SenderName = '발신자명';

    // 광고팩스 전송여부
    $adsYN = false;

    // 팩스제목
    $title = '팩스 단건전송 제목';

    // 요청번호
    // 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
    // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
    $requestNum = null;

    try {
        $receiptNum = $this->PopbillFax->SendFAX($testCorpNum, $Sender, $Receivers, $FilePaths,
            $reserveDT, $testUserID, $SenderName, $adsYN, $title, $requestNum);
    }
    catch (PopbillException $pe) {
        $code = $pe->getCode();
        $message = $pe->getMessage();
        return view('ReturnValue', ['code' => $code, 'message' => $message, 'value' => 'error']);
    }
    return view('ReturnValue', ['value' => $receiptNum]);
  }
}

팩스전송 접수번호를 출력하는 페이지(ReturnValue.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 FAX Response.</title>
  </head>
  <body>
    <div>
    <p>Response</p>
    <br/>
      <fieldset>
        <ul>
          @if ( $value != "error" )
            <li>접수번호(ReceiptNum) :  {{ $value }}</li>
          @else
            <li>오류 코드(code) :  {{ $code }}</li>
            <li>오류 메시지(message) :  {{ $message }}</li>
          @endif
        </ul>
      </fieldset>
    </div>
  </body>
</html>

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

<?php
// 생략..

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

// 생략..

4. 결과 확인

함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 로 숫자 1 반환
- 실패 : PopbillException 으로 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]