iamport/iamport-rest-client-java

JAVA사용자를 위한 아임포트 REST API 연동 모듈입니다

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.iamport:iamport-rest-client-java:0.2.23'
	}

	dependencies {
		implementation("com.github.iamport:iamport-rest-client-java:0.2.23")
	}

	<dependency>
	    <groupId>com.github.iamport</groupId>
	    <artifactId>iamport-rest-client-java</artifactId>
	    <version>0.2.23</version>
	</dependency>


                            
    libraryDependencies += "com.github.iamport" % "iamport-rest-client-java" % "0.2.23"


                            
    :dependencies [[com.github.iamport/iamport-rest-client-java "0.2.23"]]

Readme

iamport REST Client for JAVA

JAVA 사용자를 위한 아임포트 REST API 연동 모듈입니다.

com.squareup.retrofit2 모듈을 기반으로 만들어진 버전
maven plugin 형태로 제공

요구사항

JAVA 1.7이상의 버전을 요구합니다.
(dependency관계에 있는 com.squareup.retrofit2 이 JAVA 1.7이상의 버전을 요구합니다)

설치

JitPack 을 통해 maven설정을 하실 수 있습니다.

pom.xml에 아래의 내용을 추가해주세요.

<repositories>
	<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
</repositories>

<dependencies>
	<dependency>
	    <groupId>com.github.iamport</groupId>
	    <artifactId>iamport-rest-client-java</artifactId>
	    <version>0.2.23</version>
	</dependency>
</dependencies>

구현된 API

인증 API

POST /users/getToken

결제관련 기본 API

GET /payments/{imp_uid}
GET /payments/status/{payment_status}
POST /payments/cancel
POST /subscribe/payments/onetime
POST /subscribe/payments/again
POST /subscribe/payments/schedule
POST /subscribe/payments/unschedule

결제 사전검증 API

POST /payments/prepare
GET /payments/prepare/{merchant_uid}

본인인증 API

GET /certifications/{imp_uid}

에스크로 API

POST /escrows/logis/{imp_uid}

정기결제 고객정보 API

GET /subscribe/customers/{customer_uid}
POST /subscribe/customers/{customer_uid}

네이버페이 주문처리 관련 API

GET /naver/product-orders/{product_order_id}
GET /naver/reviews
GET /payments/{imp_uid}/naver/product-orders
POST /payments/{imp_uid}/naver/cancel
POST /payments/{imp_uid}/naver/ship
POST /payments/{imp_uid}/naver/place
POST /payments/{imp_uid}/naver/confirm
POST /payments/{imp_uid}/naver/point

네이버페이 반품처리 관련 API

POST /payments/{imp_uid}/naver/request-return
POST /payments/{imp_uid}/naver/approve-return
POST /payments/{imp_uid}/naver/reject-return
POST /payments/{imp_uid}/naver/withhold-return
POST /payments/{imp_uid}/naver/resolve-return

API Client 생성

일반 사용자

IamportClient client = new IamportClient("{가입한 아임포트 계정의 API key}", "{가입한 아임포트 계정의 API secret}");

Agency 사용자 (하위가맹점 관리용 계정)

IamportClient client = new IamportClient("{가입한 아임포트 계정의 API key}", "{가입한 아임포트 계정의 API secret}", "{하위가맹점 Tier Code}");

또는,

IamportClient client = new IamportClient("{가입한 아임포트 계정의 API key}", "{가입한 아임포트 계정의 API secret}");
client.setTierCode("{하위가맹점 Tier Code}");

API Client 생성(방화벽 내 사용 환경)

사내 보안정책에 의해, 아임포트 REST API 서버 접속을 위해 outbound IP 사전 등록이 필요한 환경에서는 아래 2개의 IP에 대해 방화벽 등록 후 API Client 생성시 useStaticIP(기본값 false) 인자를 true로 지정합니다.
(해당 기능은 0.2.12버전부터 제공됩니다.)

13.248.182.65
76.223.41.209

IamportClient client = new IamportClient("{가입한 아임포트 계정의 API key}", "{가입한 아임포트 계정의 API secret}", true);

0.2.x 마이그레이션

API 응답 오류 상황에 대해 명시적으로 Exception 을 발생시킴으로써 에러 핸들링이 가능하도록 수정하였습니다. 예를 들어, 기존에는 500응답이 내려오는 경우 오류 message를 확인할 수 없는 단점이 있었는데 IamportResponseException 을 throw 함으로써 정확한 오류 원인을 파악하실 수 있습니다.

또한, 서버와의 네트워크 장애 상황에서는 IOException 을 throw 하여 구분이 가능합니다.

try {
	IamportResponse<Payment> paymentResponse = client.paymentByImpUid("imp_123412341234");
	
	//TODO : 처리 로직
} catch (IamportResponseException e) {
	System.out.println(e.getMessage());
	
	switch(e.getHttpStatusCode()) {
	case 401 :
		//TODO : 401 Unauthorized 
		break;
	case 404 :
		//TODO : imp_123412341234 에 해당되는 거래내역이 존재하지 않음
	 	break;
	case 500 :
		//TODO : 서버 응답 오류
		break;
	}
} catch (IOException e) {
	//서버 연결 실패
	e.printStackTrace();
}

예제

src/test/java 의 IamportRestTest.java를 참조해주세요