튜토리얼
.NET Core 개발환경에서 팝빌 SDK를 추가하여 현금영수증 즉시 발행 (RegistIssue) 함수를 구현하는 예시입니다.
1. POPBiLL SDK 추가
[프로젝트 > NuGet 패키지 관리] 메뉴에서 popbill을 검색하여 최신 버전의 패키지를 설치합니다.
2. POPBiLL SDK 설정
① 프로젝트의 Startup.cs 파일에 koreanName 서비스 인스턴스 클래스를 생성하고, Startup클래스의 ConfigureServices() 함수에 의존성 주입 패턴으로 Singleton 서비스 인스턴스를 추가합니다.
② koreanName 서비스명으로 컨트롤러를 생성하고 생성한 컨트롤러의 생성자 함수에서 koreanName 인스턴스 객체를 할당합니다.
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Popbill.moduleName;
public class serviceNameInstance
{
// 링크아이디
private string linkID = "TESTER";
// 비밀키
private string secretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=";
// koreanName 서비스 객체 선언
public serviceNameService classNameService;
public serviceNameInstance()
{
// koreanName 서비스 객체 초기화
cashbillService = new Cashbill(linkID, seretKey);
// 연동환경 설정, true-테스트, false-운영(Production), (기본값: false)
cashbillService.IsTest = true;
// 인증토큰 IP 검증 설정, ture-사용, false-미사용, (기본값: true)
cashbillService.IPRestrictOnOff = true;
// 통신 고정 IP, true-사용, false-미사용, (기본값: false)
cashbillService.UseStaticIP = false;
// 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값: false)
cashbillService.UseLocalTimeYN = true
}
}
namespace serviceNameExample
{
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.AddSingleton<serviceNameInstance>();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
}
app.UseStaticFiles();
app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller=serviceName}/{action=Index}");
});
}
}
}
3. RegistIssue 기능 구현
현금영수증 서비스명으로 생성한 컨트롤러의 생성자 함수에 인스턴스 객체를 할당하고, 현금영수증 즉시 발행 함수(RegistIssue) 호출 코드를 추가합니다.
// Controllers/CashbillController.cs
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
using Popbill;
using Popbill.Cashbill;
namespace CashbillExample.Controllers
{
public class CashbillController : Controller
{
private readonly CashbillService _cashbillService;
public CashbillController(CashbillInstance CBinstance)
{
// 현금영수증 서비스 객체 주입
_cashbillService = CBinstance.cashbillService;
}
public IActionResult RegistIssue()
{
//팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
string corpNum = "1234567890";
//팝빌회원 아이디
string userID = "testkorea";
// 현금영수증 객체 생성
Cashbill cashbill = new Cashbill();
// 문서번호
// 문서 관리를 위해 파트너가 할당하는 식별번호
// 1~24자리 영문 대소문자, 숫자, 특수문자('-','_')로 구성
cashbill.mgtKey = "20250314-001";
// 거래일시, 형식(yyyyMMddHHmmss)
// 발행기준 전일부터 당일까지 입력 가능
// 미입력시 기본값(발행일시) 처리됨
cashbill.tradeDT = "20250319093919";
// 문서형태
cashbill.tradeType = "승인거래";
// 거래구분, [소득공제용, 지출증빙용] 중 기재
cashbill.tradeUsage = "소득공제용";
// 거래유형, [일반, 도서공연, 대중교통] 중 기재
cashbill.tradeOpt = "일반";
// 과세형태, [과세, 비과세] 중 기재
cashbill.taxationType = "과세";
// 합계금액, 공급가액 + 부가세 + 봉사료
cashbill.totalAmount = "11000";
// 공급가액
cashbill.supplyCost = "10000";
// 부가세
cashbill.tax = "1000";
// 봉사료
cashbill.serviceFee = "0";
// 가맹점 사업자번호, "-" 제외 10자리
cashbill.franchiseCorpNum = corpNum;
// 가맹점 종사업장 식별번호
cashbill.franchiseTaxRegID = "";
// 가맹점 상호
cashbill.franchiseCorpName = "가맹점 상호";
// 가맹점 대표자 성명
cashbill.franchiseCEOName = "가맹점 대표자";
// 가맹점 주소
cashbill.franchiseAddr = "가맹점 주소";
// 가맹점 전화번호
cashbill.franchiseTEL = "070-1234-1234";
// 식별번호, 거래구분에 따라 작성
// 소득공제용 - 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 기재가능
// 지출증빙용 - 사업자번호/주민등록/휴대폰/카드번호 기재가능
cashbill.identityNum = "0101112222";
// 주문 상품명
cashbill.itemName = "주문상품명";
// 주문번호
cashbill.orderNumber = "주문번호";
// 구매자(고객) 성명
cashbill.customerName = "구매자명";
// 구매자(고객) 이메일
// 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
// 실제 구매자의 메일주소가 기재되지 않도록 주의
cashbill.email = "test@test.com";
// 구매자(고객) 휴대폰
cashbill.hp = "010-111-222";
// 구매자 알림문자 전송 여부
// 알림문자 전송시 포인트가 차감되며, 전송실패시 환불처리됨
cashbill.smssendYN = false;
// 현금영수증 상태 이력을 관리하기 위한 메모
string memo = "현금영수증 즉시 발행 메모";
try
{
var response = _cashbillService.RegistIssue(corpNum, cashbill, memo, userID);
return View("Response", response);
}
catch (PopbillException pe)
{
return View("Exception", pe);
}
}
}
}
4. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 숫자 1 반환
- 실패 : PopbillException 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]