EXIMBAY 개발자센터

결제창 연동 준비

결제창을 연동할 때는 유효성 검증을 위한 결제 준비 API 호출이 포함되어 있어 SDK 준비, API 준비 모두 진행해야 합니다.
SDK로 결제창을 호출하기 전 유효성 검증을 위해 fgkey 가 필요합니다. FGKey 준비를 반드시 확인해주세요.

SDK 추가하기

결제창을 연동할 HTML 페이지에 엑심베이 라이브러리를 설치합니다.

                
<!-- jQuery -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
<!-- SDK  -->
<script type="text/javascript" src="https://api-test.eximbay.com/v1/javascriptSDK.js"></script>

엑심베이 SDK 라이브러리 설치가 완료되면 EXIMBAY 객체로 request_pay 메서드를 호출할 수 있습니다. 브라우저에 결제창이 띄워지면 결제창 연동 성공입니다.

                
<button type="button" onclick="payment();">결제 창 연동</button>
	.
	.
	.
<script type="text/javascript">
      function payment() {
          EXIMBAY.request_pay({
              "fgkey" : "0E9BE04BA239A519E68171F26B68604ADA0A85C8350DBF5C8C0FCCF98461DB09",
              "payment" : {
                  "transaction_type" : "PAYMENT",
                  "order_id" : "20220819105102",
                  "currency" : "USD",
                  "amount" : "1",
                  "lang" : "EN"
              },
              "merchant" : {
                  "mid" : "1849705C64"
              },
              "buyer" : {
                  "name" : "eximbay",
                  "email" : "test@eximbay.com"
              },
              "url" : {
                  "return_url" : "eximbay.com",
                  "status_url" : "eximbay.com"
              }
          });
      }
</script>

SDK를 호출하는 URI는 테스트 환경과 운영 환경이 서로 다릅니다. 아래 URL을 참고해주세요.

연동 환경	URL
운영계	https://api.eximbay.com
테스트계	https://api-test.eximbay.com

엑심베이 SDK에 대한 더 자세한 내용은 JavaScript SDK에서 확인하세요.

API 준비하기

API를 호출하기 위해 필요한 API 키, 인증, 요청 프로토콜 설정을 준비합니다

인증을 위한 API Key

엑심베이 API에 요청을 보내려면 인증이 반드시 필요합니다. 엑심베이 PG 계약 후 담당자 이메일로 발급된 고유한 API 키를 사용해서 인증합니다.
아직 계약 전이라도 아래 테스트 API Key를 사용해서 테스트 할 수 있습니다.

테스트 가맹점 정보

                      
  mid:   1849705C64

  API Key:   test_1849705C642C217E0B2D

이메일로 전달받은 라이브 API 키는 안전하게 보관해주세요. 브라우저와 같은 공개적으로 접근할 수 있는 곳에 API 키가 노출되지 않도록 주의가 필요합니다.

API Key 발급받기

API Key를 발급받기 위해서는 엑심베이와 PG 계약이 필요합니다. 계약 이후 등록하신 담당자 이메일로 API Key와 상점 Mid가 전달됩니다.

엑심베이 온라인 결제 연동을 위한 개발 단계라면 테스트 API Key와 테스트 Mid를, 연동 후 실제 고객에게 결제를 제공하고 싶다면 라이브 API Key와 Mid를 사용해야 합니다. 테스트 API Key를 사용하면 결제를 진행해도 실제 결제가 되지 않으며, 결제 연동 과정에서 테스트를 할 수 있습니다. 테스트 API Key는 test_로 시작하며, 라이브는 live_로 시작합니다.

API Key 종류	구분값	설명	실결제 여부	유의사항
라이브 키	live_	실제 고객 대상으로 결제를 위해 사용할 수 있습니다.	O	실결제가 이루어집니다.
테스트 키	test_	가맹점에서 결제 연동 진행시 테스트 용도로 사용할 수 있습니다.	X	실결제는 이루어지지 않습니다.

API를 호출하는 URI는 테스트 환경과 운영 환경이 서로 다릅니다. 아래 URL을 참고해주세요.

연동 환경	URL
운영계	https://api.eximbay.com
테스트계	https://api-test.eximbay.com

인증(Authentication)

HTTP 요청 헤더에 Authorization 필드를 추가하고, API Key를 Base64로 인코딩해서 값으로 넣습니다. API Key를 인코딩할 때 반드시 API Key 끝에 :를 포함해서 인코딩 해주세요. 그리고 인코딩 된 API Key 앞에 Basic을 추가해 주세요.

                    
Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=

Basic Authorization은 HTTP 기본 인증 방식 중 하나로, username:password을 Base64로 인코딩해서 사용합니다. 엑심베이 API는 username에 API 키를 넣어 사용하고 password는 사용하지 않습니다.

요청 프로토콜 설정

엑심베이 API 엔드포인트에 대한 모든 요청은 HTTPS 프로토콜을 따라야 합니다.
TLS(Transport Layer Security, 전송 계층 보안) 1.2 미만의 SSL/TLS 버전은 보안이 취약하기 때문에 TLS 버전 1.2 이상만 지원합니다.