Easily develop codef api
Project description
Overview
CODEF는 온라인에 흩어진 데이터를 클라이언트 엔진과 웹 API 등을 활용해 쉽고 빠르게 사용할 수 있도록 돕습니다. 아이디어가 구현되기 위한 복잡한 과정을 간결하게 바꾸고, 수고로움을 줄이고자 노력합니다.
easycodefpy는 CODEF API 연동 개발을 돕는 라이브러리 유틸입니다.
사용을 위해서는 홈페이지 가입 후 데모/정식 서비스 신청을 통해 자격 증명을 위한 클라이언트 정보 등을 발급받아야 하며 사용 가능한 모든 API의 엔드포인트(은행, 카드, 보험, 증권, 공공, 기타)와 요청/응답 항목은 모두 개발가이드를 통해 확인할 수 있습니다.
Get it!
$ python -m pip install easycodefpy
Use it!
Quik Start
아래 가이드는 easycodefpy-exam를 기반으로 작성되었으며 샌드박스 서버를 대상으로 즉시 테스트가 가능합니다.
샌드박스에서는 필수 요청 파라미터 여부를 체크한 뒤 요청 상품에 따른 예정되어 있는 고정 응답 값을 반환합니다.
사용자는 샌드박스를 통해 코드에프 연동에 대한 개발 연습과 상품 별 응답 자료 구조 등을 확인 할 수 있습니다.
1. 토큰 요청
CODEF API 서비스를 이용하기 위해서는 서비스 이용에 대한 자격 증명을 통해 토큰을 발급받아야 합니다. 토큰은 모든 요청시 헤더 값에 포함되어야 하며 한번 발급 받은 토큰은 일주일간 재사용이 가능합니다.
easycodefpy 라이브러리는 토큰의 발급과 재사용을 자동으로 처리합니다.
재사용 중인 토큰의 유효기간이 만료되는 경우 재발급 또한 자동으로 처리됩니다.
사용자는 단순히 자격증명을 위한 클라이언트 정보 설정 만을 진행하면 됩니다.
아래의 예제는 사용자가 직접 토큰을 발급받는 과정을 설명합니다.
계정 관리나 상품 요청시 토큰은 라이브러리 내에서 자동 발급받아 사용하기 때문에 특별한 경우가 아니라면 사용자가 직접 토큰을 요청할 필요는 없습니다.
예제 링크 https://github.com/codef-io/easycodefpy-exam/blob/master/00_access_token/main.py
from easycodefpy import Codef, ServiceType
demo_client_id = ''
demo_client_secret = ''
client_id = ''
client_secret = ''
public_key = ''
# 코드에프 인스턴스 생성
codef = Codef()
codef.public_key = public_key
# 데모 클라이언트 정보 설정
# - 데모 서비스 가입 후 코드에프 홈페이지에 확인 가능(https://codef.io/#/account/keys)
# - 데모 서비스로 상품 조회 요청시 필수 입력 항목
codef.set_demo_client_info(demo_client_id, demo_client_secret)
# 정식 클라이언트 정보 설정
# - 정식 서비스 가입 후 코드에프 홈페이지에 확인 가능(https://codef.io/#/account/keys)
# - 정식 서비스로 상품 조회 요청시 필수 입력 항목
codef.set_client_info(client_id, client_secret)
# 토큰 발급 요청
token = codef.request_token(ServiceType.SANDBOX)
# 결과 출력
print(token)
2. 계정 관리
CODEF API 서비스의 여러 상품들 중 요청 파라미터에 Connected ID가 필요한 경우가 있습니다. 인증이 필요한 CODEF API를 사용하기 위해서는 엔드 유저(End User) 계정 정보(대상기관의 인증수단)등록이 필요하며, 이를 통해 사용자마다 다른 Connected ID를 발급받을 수 있습니다. (Connected ID는 개발가이드 인증방식에서 자세한 내용을 확인하세요.)
Connected ID 발급 이후에는 직접적인 계정 정보 전송 없이 대상기관의 데이터를 요청할 수 있습니다. Connected ID는 계정 등록 요청 시 발급되며 이후 계정 추가/계정 수정/계정 삭제 요청으로 관리할 수 있습니다. 동일한 기관의 동일한 계정 정보는 중복해서 등록할 수 없으며 개인 고객/기업 고객 각각 1개씩 등록이 가능합니다.
모든 상품의 파라미터에 Connected ID가 필요한 것은 아닙니다. 상품별 파라미터는 개발가이드 상품안내에서 확인할 수 있습니다.
Connected ID를 사용하지 않는 API를 사용하는 경우 계정 관리는 생략하세요.
예제 링크 https://github.com/codef-io/easycodefpy-exam/blob/master/01_create_account/main.py
...
# 요청 파라미터 설정
# - 계정관리 파라미터를 설정(https://developer.codef.io/cert/account/cid-overview)
account_list = []
account = {
'countryCode': 'KR',
'businessType': 'BK',
'clientType': 'P',
'organization': '0004',
'loginType': '1',
'id': "user_id",
}
# 비밀번호 설정
pwd = encrypt_rsa("password", codef.public_key)
account['password'] = pwd
account_list.append(account)
parameter = {
'accountList': account_list,
}
# 요청
res = codef.create_account(ServiceType.SANDBOX, parameter)
print(res)
계정 등록 요청은 등록하려는 여러 기관의 계정을 목록 파라미터로 설정해 한번에 요청이 가능하며 응답 결과는 아래와 같습니다. 사용자는 발급받은 Connected ID를 계정 등록에 성공한 기관(successList) 상품 조회 요청시 사용을 할 수 있습니다.
예) 국민은행(0004)으로 등록한 Connected ID를 산업은행(0002) 상품 조회시 사용할 수 없음
{
"result" : {
"code" : "CF-00000",
"extraMessage" : "",
"message" : "정상",
"transactionId":"786e01e459af491888e1f782d1902e40"
},
"data" : {
"successList" : [ {
"code" : "CF-00000",
"message" : "정상",
"extraMessage" : "",
"countryCode" : "KR",
"businessType" : "BK",
"clientType" : "P",
"loginType" : "1",
"organization" : "0004"
}],
"errorList" : [ ],
"connectedId" : "byi1wYwD40k8hEIiXl6bRF"
}
}
계정 등록 이외의 계정 추가, 수정, 삭제 등의 계정 관리 기능과 계정 목록 조회, Connected ID 목록 조회 등 조회 기능은 easycodefpy-exam에서 확인 할 수 있습니다.
인증서로 계정을 등록하는 경우에는 cert파일, key파일 세트 혹은 pfx파일 2가지 모두를 지원합니다. 개발가이드 계정등록에서 자세한 내용을 확인하세요. 인증서 내보내기/가져오기 등 인증서 릴레이 서버 기능이 필요한 경우 support@codef.io로 문의해주시기 바랍니다. 코드에프에서는 계정 관리를 위한 인증서 팝업과 전송 서버를 서비스 하고 있습니다.
3. 상품 요청
엔드 유저의 계정 등록 과정을 거쳐 상품 사용 준비가 끝났다면 이제 발급받은 Connected ID와 필요한 파라미터 정보 설정 등을 통해 코드에프 API 상품 요청을 할 수 있습니다. Connected ID를 사용하는 상품과 Connected ID를 사용하지 않는 상품 요청 예제를 아래 코드를 통해 확인하겠습니다.
한번 더 강조하자면 모든 상품의 파라미터에 Connected ID가 필요한 것은 아닙니다.
상품별 파라미터는 개발가이드 상품안내에서 확인할 수 있습니다.
- 일반 상품
예제 코드 https://github.com/codef-io/easycodefpy-exam/tree/master/07_product/main.py
from easycodefpy import Codef, ServiceType
demo_client_id = ''
demo_client_secret = ''
client_id = ''
client_secret = ''
public_key = ''
# 코드에프 인스턴스 생성
codef = Codef()
codef.public_key = public_key
# 데모 클라이언트 정보 설정
# - 데모 서비스 가입 후 코드에프 홈페이지에 확인 가능(https://codef.io/#/account/keys)
# - 데모 서비스로 상품 조회 요청시 필수 입력 항목
codef.set_demo_client_info(demo_client_id, demo_client_secret)
# 정식 클라이언트 정보 설정
# - 정식 서비스 가입 후 코드에프 홈페이지에 확인 가능(https://codef.io/#/account/keys)
# - 정식 서비스로 상품 조회 요청시 필수 입력 항목
codef.set_client_info(client_id, client_secret)
# 요청 파라미터 설정
# - 각 상품별 파라미터를 설정(https://developer.codef.io/products)
parameter = {
'connectedId': '8PQI4dQ......hKLhTnZ',
'organization': '0004',
}
# 코드에프 정보 조회 요청
# - 서비스타입(0:정식, 1:데모, 2:샌드박스)
# 개인 보유계좌 조회 (https://developer.codef.io/products/bank/common/p/account)
product_url = "/v1/kr/bank/p/account/account-list"
res = codef.request_product(product_url, ServiceType.SANDBOX, parameter)
print(res)
쉬운 코드에프 객체 생성 후 클라이언트 정보 등을 설정한 다음 개인 보유계좌 조회를 위한 파라미터를 설정해서 상품 요청을 합니다.
라이브러리 사용자는 토큰 발급이나 토큰 관리, 요청 파라미터의 인코딩, 응답 바디의 디코딩 등 API이용을 위한 부수적인 작업을 직접 할 필요가 없습니다.
상품 요청에 필요한 파라미터를 설정하고 request_product 메서드 호출만으로 Connected ID로 등록된 계정의 기관(0004 국민은행)의 목록을 아래와 같이 응답받게 됩니다.
{
"result":{
"code":"CF-00000",
"extraMessage":"",
"message":"성공",
"transactionId":"5069429e367745baba92f5c12c4343de"
},
"data":{
"resDepositTrust":[
{
"resAccount":"06170204000000",
"resAccountBalance":"874890",
"resAccountCurrency":"KRW",
"resAccountDeposit":"11",
"resAccountDisplay":"061702-04-000000",
"resAccountEndDate":"",
"resAccountLifetime":"",
"resAccountName":"저축예금",
"resAccountNickName":"",
"resAccountStartDate":"20120907",
"resLastTranDate":""
},
{
"resAccount":"23850204000000",
"resAccountBalance":"0",
"resAccountCurrency":"KRW",
"resAccountDeposit":"11",
"resAccountDisplay":"238502-04-000000",
"resAccountEndDate":"",
"resAccountLifetime":"",
"resAccountName":"직장인우대통장-저축예금",
"resAccountNickName":"급여통장",
"resAccountStartDate":"20060413",
"resLastTranDate":""
},
{
"resAccount":"54780300000000",
"resAccountBalance":"13110000",
"resAccountCurrency":"KRW",
"resAccountDeposit":"12",
"resAccountDisplay":"547803-00-000000",
"resAccountEndDate":"",
"resAccountLifetime":"",
"resAccountName":"OO국민재형저축",
"resAccountNickName":"",
"resAccountStartDate":"20151228",
"resLastTranDate":""
}
],
"resForeignCurrency":[],
"resFund":[],
"resInsurance":[],
"resLoan":[
{
"resAccount":"75260904000000",
"resAccountBalance":"120000000",
"resAccountCurrency":"KRW",
"resAccountDeposit":"40",
"resAccountDisplay":"752609-04-000000",
"resAccountEndDate":"20210628",
"resAccountLoanExecNo":"",
"resAccountName":"서울특별시신혼부부임차보증금대출",
"resAccountNickName":"",
"resAccountStartDate":"20190628"
}
]
}
}
이번에는 사업자 휴폐업 상태 정보를 조회하는 상품의 예제입니다.
# 사업자등록상태(휴폐업조회)(Connected ID 미사용)
from easycodefpy import Codef, ServiceType
demo_client_id = ''
demo_client_secret = ''
client_id = ''
client_secret = ''
public_key = ''
# 코드에프 인스턴스 생성
codef = Codef()
codef.public_key = public_key
# 데모 클라이언트 정보 설정
# - 데모 서비스 가입 후 코드에프 홈페이지에 확인 가능(https://codef.io/#/account/keys)
# - 데모 서비스로 상품 조회 요청시 필수 입력 항목
codef.set_demo_client_info(demo_client_id, demo_client_secret)
# 정식 클라이언트 정보 설정
# - 정식 서비스 가입 후 코드에프 홈페이지에 확인 가능(https://codef.io/#/account/keys)
# - 정식 서비스로 상품 조회 요청시 필수 입력 항목
codef.set_client_info(client_id, client_secret)
# 요청 파라미터 설정
# - 각 상품별 파라미터를 설정(https://developer.codef.io/products)
parameter = {
'organization': "0004",
}
req_identity_list = [{
'reqIdentity': '3333344444',
}, {
'reqIdentity': '1234567890',
}]
parameter['req_identity_list'] = req_identity_list
# 코드에프 정보 조회 요청
# - 서비스타입(0:정식, 1:데모, 2:샌드박스)
product_url = '/v1/kr/public/nt/business/status'
res = codef.request_product(product_url, ServiceType.SANDBOX, parameter)
print(res)
2개의 상폼 요청 예시를 비교해 코드의 내용을 살펴보면 개인 보유카드 조회와 사업자등록상태 조회의 차이는 요청주소(URL)와 파라미터 설정에만 있는 것을 확인할 수 있습니다.
사용자는 라이브러리 사용을 통해 일관된 형태의 코드를 작성하여 개발할 수 있고 다른 사람이 작성한 상품 요청 코드를 쉽게 이해할 수 있습니다.
{
"result" : {
"code" : "CF-00000",
"extraMessage" : "",
"message" : "성공",
"transactionId" : "786e01e459af491888e1f782d1902e40"
},
"data" : [ {
"resBusinessStatus" : "사업을하지않고있습니다.",
"resCompanyIdentityNo" : "3333344444",
"code" : "CF-00000",
"resTaxationTypeCode" : "98",
"extraMessage" : null,
"resClosingDate" : "",
"resTransferTaxTypeDate" : "",
"message" : "성공"
}, {
"resBusinessStatus" : "부가가치세일반과세자입니다.\n*과세유형전환된날짜는2011년07월01일입니다.",
"resCompanyIdentityNo" : "1234567890",
"code" : "CF-00000",
"resTaxationTypeCode" : "1",
"extraMessage" : null,
"resClosingDate" : "",
"resTransferTaxTypeDate" : "20110701",
"message" : "성공"
} ]
}
- 추가 인증 상품
추가 인증 상품이란 API호출 한번으로 요청 결과를 받을 수 있는 일반 상품과는 달리 첫 요청 이후 대상기관이 요구하는 추가 인증(이메일, SMS, 보안문자 입력 등)을 수행해야 요청 결과를 받을 수 있는 상품을 의미합니다.
예를 들어 아래 그림과 같이 로그인을 하는 경우 아이디와 비밀번호 외에 대상기관에서 추가적으로 요구하는 보안문자 입력이 진행되어야 합니다. 고정 값인 아이디, 비밀번호와 다르게 보안문자 이미지는 랜덤하게 반환되기 때문에 엔드 유저의 추가적인 정보 입력이 필요합니다.
대상기관이 요구하는 인증방식에 따라 N차 추가인증이 요구 될 수 있으며, 추가 인증 정보 입력이 진행되어야 정상적으로 CODEF API 요청도 완료됩니다. 1차 입력부[기본파라미터] -> n차 추가 인증[기본 파라미터 + 추가 인증 파라미터] 요청으로 이루어집니다. 추가 인증은 사용자 인증을 위한 정보가 대부분이며 추가 인증 요청시에도 Endpoint URL은 동일합니다.
샌드박스 서버를 통해 추가인증 상품에 대한 테스트를 진행 할 수는 없습니다.
추가 인증에 필요한 파라미터 설명은 개발 가이드의 각 상품 페이지에서 확인할 수 있으며 자세한 내용은 개발가이드 추가인증을 통해 확인하세요.
요청 타입
코드에프 요청시 샌드박스 외 다른 타입으로 요청을 보내실 경우 아래 타입을 사용할 수 있습니다.
class ServiceType(Enum):
PRODUCT = 0 # 정식
DEMO = 1 # 데모
SANDBOX = 2 # 샌드박스
Ask us
easycodefpy 라이브러리 사용에 대한 문의사항과 개발 과정에서의 오류 등에 대한 문의를 홈페이지 문의게시판에 올려주시면 운영팀이 답변을 드립니다. 문의게시판의 작성 양식에 맞춰 문의 글을 남겨주세요. 가능한 빠르게 응답을 드리겠습니다.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for easycodefpy-1.0.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fba755b6d6db413e9ddbc73bf3d448fc046d7b661cecc1fd87758080e3dd2e35 |
|
| MD5 | 0c6c45b33042a8a135ab03f35c5da74b |
|
| BLAKE2b-256 | 184a493e7a382575c7c3a7bf529b03acc5568acb9d7b165a989d803031ca5397 |
