튜토리얼 - PHP
PHP 개발환경에서 팝빌 SDK를 추가하고, 전자명세서 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
1. POPBiLL SDK 추가 및 설정
섹션 제목: “1. POPBiLL SDK 추가 및 설정”① 팝빌 연동자료실에서 PHP SDK 예제코드 다운로드 후 압축을 해제합니다.
② 압축해제한 SDK 예제코드에 포함된 Popbill/ 폴더를 웹사이트 Root Directory 경로에 복사합니다.
③ 서비스 연동환경 설정을 위해 프로젝트 Root Directory에 common.php 파일을 생성하고 아래의 코드를 참고하여 API Key 를 설정합니다.
<?php require_once './Popbill/PopbillStatement.php';
// API Key // - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성) // • LinkID: 파트너를 식별하기 위한 고유 식별자 // • SecretKey: API 인증토큰 발급에 사용되는 키 // // TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요. $LinkID = 'TESTER'; $SecretKey = 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=';
// 통신방식 기본은 CURL , curl 사용에 문제가 있을경우 STREAM 사용가능. // STREAM 사용시에는 php.ini의 allow_url_fopen = on 으로 설정해야함. define('LINKHUB_COMM_MODE','CURL');
// 전자명세서 서비스 객체 초기화 $StatementService = new StatementService($LinkID, $SecretKey);
// 연동환경(테스트/운영) 설정 // - 연동환경을 테스트 또는 운영으로 설정합니다. // • true: 테스트 환경으로 설정 // • false(default) : 운영 환경으로 설정 // // ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다. $StatementService->IsTest(true);
// 인증토큰 IP 일치 검증 사용 여부 // - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다. // (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치) // • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용 // • false(미사용) : IP 일치 검사를 생략 // // ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용 // 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경 $StatementService->IPRestrictOnOff(true);
// 통신 IP 고정 여부 // - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다. // • true(사용) : 고정(Static) IP 사용 // • false(미사용, default) : 가변(Elastic) IP 사용 // // ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다. // (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능) $StatementService->UseStaticIP(false);
// 로컬시스템 시간 사용 여부 // - 현재시각 기준을 설정합니다. // • true(사용, default) : 로컬시스템 시간 사용 // • false(미사용) : 팝빌 서버의 시간을 사용 // // ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다. // ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다. // ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나 // 서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다. $StatementService->UseLocalTimeYN(true);?>2. RegistIssue 기능 구현
섹션 제목: “2. RegistIssue 기능 구현”프로젝트 Root Directory에 함수 호출을 처리하는 파일을 생성하고, 아래의 코드를 참조하여 코드를 추가합니다.
<html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>Popbill Statement Response.</title> </head><?php
include 'common.php';
// 팝빌 회원 사업자번호, '-' 제외 10자리 $testCorpNum = '1234567890';
// 전자명세서 문서번호 // 1~24자리 숫자, 영문, '-', '_' 조합으로 사업자별로 중복되지 않도록 구성 $mgtKey = '20250314-01';
// 명세서 종류코드 - 121(거래명세서), 122(청구서), 123(견적서) 124(발주서), 125(입금표), 126(영수증) $itemCode = '121';
// 전자명세서 객체 생성 $Statement = new Statement();
/************************************************************ * 전자명세서 정보 ************************************************************/
// [필수] 기재상 작성일자 $Statement->writeDate = '20250314';
// [필수] (영수, 청구, 없음) 중 기재 $Statement->purposeType = '영수';
// [필수] 과세형태, (과세, 영세, 면세) 중 기재 $Statement->taxType = '과세';
// 맞춤양식코드, 미기재시 기본양식으로 처리 $Statement->formCode = '';
// 명세서 종류 코드 $Statement->itemCode = $itemCode;
// 전자명세서 문서번호 $Statement->mgtKey = $mgtKey;
/************************************************************ * 공급자 정보 ************************************************************/
$Statement->senderCorpNum = $testCorpNum; $Statement->senderTaxRegID = ''; $Statement->senderCorpName = '공급자 상호'; $Statement->senderCEOName = '공급자 대표자 성명'; $Statement->senderAddr = ' 공급자 주소'; $Statement->senderBizClass = '공급자 업종'; $Statement->senderBizType = '공급자 업태'; $Statement->senderContactName = '공급자 담당자명'; $Statement->senderTEL = '070-7070-0707'; $Statement->senderHP = '010-000-2222'; $Statement->senderEmail = 'test@test.com';
/************************************************************ * 공급받는자 정보 ************************************************************/
$Statement->receiverCorpNum = '8888888888'; $Statement->receiverTaxRegID = ''; // 공급받는자 종사업장 식별번호, 필요시 기재. 형식은 숫자 4자리 $Statement->receiverCorpName = '공급받는자 상호'; $Statement->receiverCEOName = '공급받는자 대표자 성명'; $Statement->receiverAddr = '공급받는자 주소'; $Statement->receiverBizClass = '공급받는자 업종'; $Statement->receiverBizType = '공급받는자 업태'; $Statement->receiverContactName = '공급받는자 담당자명'; $Statement->receiverTEL = '010-0000-1111'; $Statement->receiverHP = '010-1111-2222'; $Statement->receiverEmail = 'test@linkhubcorp.com'; // 수신자 이메일주소 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로, 실제 거래처의 메일주소가 기재되지 않도록 주의
/************************************************************ * 전자명세서 기재정보 ************************************************************/
$Statement->supplyCostTotal = '200000'; // [필수] 공급가액 합계 $Statement->taxTotal = '20000'; // [필수] 세액 합계 $Statement->totalAmount = '220000'; // [필수] 합계금액 (공급가액 합계+세액합계)
$Statement->serialNum = '123'; // 기재상 일련번호 항목 $Statement->remark1 = '비고1'; $Statement->remark2 = '비고2'; $Statement->remark3 = '비고3';
$Statement->businessLicenseYN = False; // 사업자등록증 첨부 여부 $Statement->bankBookYN = False; // 통장사본 첨부 여부 $Statement->smssendYN = False; // 발행시 안내문자 전송여부
/************************************************************ * 상세항목(품목) 정보 ************************************************************/
$Statement->detailList = array();
$Statement->detailList[0] = new StatementDetail();
$Statement->detailList[0]->serialNum = '1'; // 품목 일련번호 1부터 순차 기재 $Statement->detailList[0]->purchaseDT = '20250314'; // 거래일자 yyyyMMdd $Statement->detailList[0]->itemName = '품명'; $Statement->detailList[0]->spec = '규격'; $Statement->detailList[0]->unit = '단위'; $Statement->detailList[0]->qty = '1000'; // 수량 $Statement->detailList[0]->unitCost = '1000000'; $Statement->detailList[0]->supplyCost = '10000000'; $Statement->detailList[0]->tax = '1000000'; $Statement->detailList[0]->remark = '11,000,000'; $Statement->detailList[0]->spare1 = '1000000'; $Statement->detailList[0]->spare2 = '1000000'; $Statement->detailList[0]->spare3 = 'spare3'; $Statement->detailList[0]->spare4 = 'spare4'; $Statement->detailList[0]->spare5 = 'spare5';
$Statement->detailList[1] = new StatementDetail(); $Statement->detailList[1]->serialNum = '2'; // 품목 일련번호 순차기재 $Statement->detailList[1]->purchaseDT = '20250314'; // 거래일자 yyyyMMdd $Statement->detailList[1]->itemName = '품명'; $Statement->detailList[1]->spec = '규격'; $Statement->detailList[1]->unit = '단위'; $Statement->detailList[1]->qty = '1'; $Statement->detailList[1]->unitCost = '100000'; $Statement->detailList[1]->supplyCost = '100000'; $Statement->detailList[1]->tax = '10000'; $Statement->detailList[1]->remark = '비고'; $Statement->detailList[1]->spare1 = 'spare1'; $Statement->detailList[1]->spare2 = 'spare2'; $Statement->detailList[1]->spare3 = 'spare3'; $Statement->detailList[1]->spare4 = 'spare4'; $Statement->detailList[1]->spare5 = 'spare5';
/************************************************************ * 전자명세서 추가속성 ************************************************************/
$Statement->propertyBag = array( 'Balance' => '50000', 'Deposit' => '100000', 'CBalance' => '150000' );
// 메모 $memo = '즉시 발행 메모';
// 팝빌 회원 아이디 $testUserID = 'testkorea';
// 발행 안내메일 제목 // 공백처리시 기본양식으로 전송됨. $emailSubject = null;
try { $result = $StatementService->RegistIssue($testCorpNum, $Statement, $memo, $testUserID, $emailSubject); $code = $result->code; $message = $result->message; } catch(PopbillException $pe) { $code = $pe->getCode(); $message = $pe->getMessage(); }?> <body> <div id="content"> <p class="heading1">Response</p> <br/> <fieldset class="fieldset1"> <legend>전자명세서 즉시 발행</legend> <ul> <li>Response.code : <?php echo $code ?></li> <li>Response.message : <?php echo $message ?></li> </ul> </fieldset> </div> </body></html>3. API 응답결과 확인
섹션 제목: “3. API 응답결과 확인”API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
|---|---|
| 성공 | code : 1 |
| 실패 | code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지 |