REST client for I'mport;(http://www.iamport.kr)
Project description
Python 사용자를 위한 아임포트 REST API 연동 모듈입니다.
이용 중 발생한 문제에 대해 책임지지 않습니다.
lexifdev님의 도움을 받아 작성되었습니다(lexifdev’s iamport 모듈)
최초 작성은 핑크퐁 북스토어 에서 쓰기 위해 만들었습니다.
설치
pip install iamport-rest-client
기능
결제 정보 찾기
가격 확인
취소
비 인증 결제
정기 예약 결제
사용법
준비
사용하기 위해 객체를 만듭니다.
from iamport import Iamport
# 테스트 용
iamport = Iamport(imp_key='{테스트용 키}', imp_secret='{테스트 시크릿}')
# 테스트용 키와 시크릿은 tests/conftest.py 파일에 DEFAULT_TEST_IMP_KEY, DEFAULT_TEST_IMP_SECRET를 참고하세요.
# 실제 상점 정보
iamport = Iamport(imp_key='{발급받은 키}', imp_secret='{발급받은 시크릿}')
찾기
결제를 진행한 상품 아이디나, 전달받은 IMP 아이디를 이용해 결제 정보를 찾습니다.
# 상품 아이디로 조회
response = iamport.find(merchant_uid='{상품 아이디}')
# I'mport; 아이디로 조회
response = iamport.find(imp_uid='{IMP UID}')
가격 확인
실제 제품 가격과 결제된 가격이 같은지 확인합니다.
# 상품 아이디로 확인
iamport.is_paid(product_price, merchant_uid='{상품 아이디}')
# I'mport; 아이디로 확인
iamport.is_paid(product_price, imp_uid='{IMP UID}')
# 이미 찾은 response 재활용하여 확인
iamport.is_paid(product_price, response=response)
취소
결제를 취소합니다.
# 상품 아이디로 취소
response = iamport.cancel(u'취소하는 이유', merchant_uid='{상품 아이디}')
# I'mport; 아이디로 취소
response = iamport.cancel(u'취소하는 이유', imp_uid='{IMP UID}')
# 취소시 오류 예외처리(이미 취소된 결제는 에러가 발생함)
try:
response = iamport.cancel(u'취소하는 이유', imp_uid='{IMP UID}')
except Iamport.ResponseError as e:
print e.code
print e.message # 에러난 이유를 알 수 있음
except Iamport.HttpError as http_error:
print http_error.code
print http_error.reason # HTTP not 200 에러난 이유를 알 수 있음
비인증 결제
1회성 비인증 결제를 진행합니다.
# 테스트용 값
payload = {
'merchant_uid': '00000000',
'amount': 5000,
'card_number': '4092-0230-1234-1234',
'expiry': '2019-03',
'birth': '500203',
'pwd_2digit': '19'
}
try:
response = iamport.pay_onetime(**payload)
except KeyError:
# 필수 값이 없을때 에러 처리
pass
except Iamport.ResponseError as e:
# 응답 에러 처리
pass
except Iamport.HttpError as http_error:
# HTTP not 200 응답 에러 처리
pass
저장된 빌링키로 재결제합니다.
# 테스트용 값
payload = {
'customer_uid': '{고객 아이디}',
'merchant_uid': '00000000',
'amount': 5000,
}
try:
response = iamport.pay_again(**payload)
except KeyError:
# 필수 값이 없을때 에러 처리
pass
except Iamport.ResponseError as e:
# 응답 에러 처리
pass
except Iamport.HttpError as http_error:
# HTTP not 200 응답 에러 처리
pass
정기 예약 결제
정기 결제를 예약합니다.
# 테스트용 값
payload = {
'customer_uid': '{고객 아이디}',
'schedules': [
{
'merchant_uid': 'test_merchant_01',
# UNIX timestamp
'schedule_at': 1478150985,
'amount': 1004
},
{
'merhcant_uid': 'test_merchant_02',
# UNIX timestamp
'schedule_at': 1478150985,
'amount': 5000,
'name': '{주문명}',
'buyer_name': '{주문자명}',
'buyer_email': '{주문자 이메일}',
'buyer_tel': '{주문자 전화번호}',
'buyer_addr': '{주문자 주소}',
'buyer_postcode': '{주문자 우편번호}',
},
]
}
try:
reponse = iamport.pay_schedule(**payload)
except KeyError:
# 필수 값이 없을때 에러 처리
pass
except Iamport.ResponseError as e:
# 응답 에러 처리
pass
except Iamport.HttpError as http_error:
# HTTP not 200 응답 에러 처리
pass
정기 결제 예약을 취소합니다.
# 테스트용 값 (merchant_uid 가 누락되면 customer_uid 에 대한 결제예약정보 일괄취소)
payload = {
'customer_uid': '{고객 아이디}',
'merchant_uid': 'test_merchant_01',
}
try:
response = iamport.pay_unschedule(**payload)
except KeyError:
# 필수 값이 없을때 에러 처리
pass
except Iamport.ResponseError as e:
# 응답 에러 처리
pass
except Iamport.HttpError as http_error:
# HTTP not 200 응답 에러 처리
pass
결제 사전 검증
결제될 내역에 대한 사전정보를 등록합니다
# 테스트용 값
amount = 12000
mid = 'merchant_test'
try:
response = iamport.prepare(amount=amount, merchant_uid=mid)
except Iamport.ResponseError as e:
# 응답 에러 처리
pass
except Iamport.HttpError as http_error:
# HTTP not 200 응답 에러 처리
pass
등록된 사전정보를 확인합니다
# 테스트용 값
amount = 12000
mid = 'merchant_test'
try:
result = iamport.prepare_validate(merchant_uid=mid, amount=amount)
except Iamport.ResponseError as e:
# 응답 에러 처리
pass
except Iamport.HttpError as http_error:
# HTTP not 200 응답 에러 처리
pass
개발환경 및 테스트 설정
macOS 기준 pyenv 설치 권장
# pyenv 준비 brew install pyenv pyenv install -s 2.7.13 pyenv install -s 3.4.7 pyenv install -s 3.5.4 pyenv install -s 3.6.2 pyenv install -s pypy-5.7.1 pyenv local 2.7.13 3.4.7 3.5.4 3.6.2 pypy-5.7.1 pip install pytest pytest-cov collective.checkdocs Pygments tox-pyenv # tox tox # 커버리지 확인 python -m pytest tests/ --cov=./ # 문서 확인 python setup.py checkdocs
기여
할 일
결제 목록 읽기
비인증 결제 세부 기능 지원
문서화
기타 등등
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for iamport-rest-client-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70eef12aad274881c18589b29a43df0db1444bf8580df82222b89c12d16da8be |
|
MD5 | 5d2699b6ab62d8c94e84ca6f49033476 |
|
BLAKE2b-256 | 65c3b36375d5cd2b413b7a7bf6b905efcf52ea8aac52944c29682b5962cfd3b7 |