반응형
| 용어 | 설명 |
| 키 | CODEF 홈페이지에 회원 가입 후 서비스 등록을 신청하면, 마이페이지-키관리 탭에서 clientId, clientSecret, publicKey 등 CODEF API 사용에 필요한 키를 확인할 수 있습니다. |
| 계정 삭제 | 엔드 유저가 등록된 계정 삭제 요청 시 커넥티드 아이디(Connected ID)에 등록된 계정 정보를 즉시 삭제할 수 있습니다. 삭제된 계정 정보는 복구할 수 없습니다. |
| 계정 수정 | 발급받은 커넥티드 아이디(Connected ID)에 해당하는 계정 정보를 수정할 수 있습니다. 커넥티드 아이디 발급 후 엔드 유저가 계정 정보를 변경한 경우(인증서 갱신/재발급, ID/PW에서 비밀번호 변경 등) 기존 발급된 커넥티드 아이디에 해당하는 계정 정보를 변경된 계정 정보로 수정이 반드시 필요합니다. 자세한 방법은 계정수정 페이지를 참고하시기 바랍니다. |
| 계정 추가 | 계정 등록을 통해 발급받은 커넥티드 아이디(Connected ID)에 새로운 기관을 추가 등록 할 수 있습니다. 추가된 기관을 포함하여 동일한 커넥티드 아이디로 CODEF API 상품을 이용할 수 있습니다. |
| 계정 등록 | 인증이 필요한 CODEF API를 사용하기 위해서는 엔드 유저(End User) 계정 정보(대상기관의 인증수단)등록이 필요하며, 이를 통해 사용자마다 유니크한 커넥티드 아이디(Connected ID)를 발급받을 수 있습니다. 이후에는 별도의 계정 정보 전송 없이 커넥티드 아이디를 통해서 대상기관의 데이터를 연동할 수 있습니다. 커넥티드 아이디는 계정 등록 요청 시에 발급되며 이후 계정 추가/계정 수정/계정 삭제 요청으로 관리 할 수 있습니다. |
| 오류코드 | CODEF API는 엔진, 통신, 기관 정책, 기관 장애, 엔드 유저 환경, 엔드 유저 인증 등 다양한 상황에 따라 오류가 발생할 수 있습니다. 오류 코드와 메시지에 따른 추가 설명을 오류코드 메뉴에 표로 정리했습니다. 행을 클릭하시면 상세한 오류내용을 볼 수 있습니다. 오류 코드는 result 내 code 값에 담깁니다. |
| 웹훅 | 웹훅은 프로젝트 관련 이벤트가 발생했을 때 클라이언트 서버로 HTTP 통신을 POST 방식으로 요청하는 기능입니다. 데이터는 JSON 형태로 제공됩니다. 클라이언트는 웹훅 이벤트 종류 및 URL을 설정할 수 있으며, 프로젝트 하나에 웹훅 여러 개를 설정할 수 있습니다. 자세한 내용은 개발 가이드 - 웹훅 탭에서 확인할 수 있습니다. |
| 간편인증 재시도 | 간편인증을 완료하지 않고 간편인증 값에 '인증 완료(1)'를 넣어 2차 요청을 할 경우 'CF-03002' 코드가 반환됩니다. 이 과정은 3회 진행되며, 3회 재시도 내 간편인증을 처리할 경우 정상처리 됩니다. 하지만 3회 재시도 시에도 간편인증을 완료하지 않을 경우 'CF-12872' 코드가 반환되며 더 이상 재시도를 진행할 수 없습니다. |
| 요청 식별 아이디 | 요청 식별 아이디는 같은 사용자의 요청을 함께 처리하기 위한 아이디 값입니다. 즉, 사용자가 요청A와 요청B를 요청했을 경우 요청A와 요청B가 같은 사용자의 요청임을 식별하기 위한 값입니다. 때문에 사용자의 요청A와 요청B에 같은 요청 식별 아이디 값을 부여해야 하며, 로그인 정보가 다른 사용자와는 다른 요청 식별 아이디 값을 부여해야 합니다. |
| identityEncYn (identity 파라미터 암호화 여부) | 일부 API 상품에는 요청 파라미터로 주민등록번호(identity)가 필요합니다. API 요청을 위한 모든 통신 구간은 SSL 인증서 기반으로 암호화되기 때문에 기본적으로 identity 파라미터에 별도의 암호화를 요구하지는 않습니다. 그러나 엄격한 보안을 원하는 경우에는 요청 파라미터에 identityEncYn 필드를 추가하고 값을 'Y'로 설정한 후 identity 를 RSA 암호화해서 API 요청을 할 수 있습니다. |
| Multi Channel Authentication ( 다중 채널 인증) | 다중 채널 인증은 물리적으로 다른 통신 채널을 사용합니다. PC와 스마트폰을 활용할 때는 ARS 인증, SMS 인증, 스마트폰 OTP 등 물리적으로 분리된 정보를 사용합니다. |
| Multi Factor Authentication(다중 요소 인증) | 다중 요소 인증은 아이디/패스워드, PIN 등 지식 기반 인증과 OTP 등 소유 기반 인증, 지문 등 생체 기반 인증이 있습니다. |
| 추가인증 | 추가 인증은 각 기관에서 보안 향상을 위해 사용하는 방법입니다. 기관에서 추가 인증을 요구하는 상품은 CODEF API 사용 시에도 추가 인증을 해야 합니다. 추가 인증의 종류는 다중 요소 인증(Multi Factor Authentication), 다중 채널 인증(Multi Channel Authentication) 등이 있습니다. |
| Timeout | CODEF는 API 상품별 최대 응답 대기 시간이 존재합니다. 응답 지연 요소로는 대표적으로 조회 결과가 매우 많은 경우 혹은 대상기관 서버의 응답 지연이 발생하는 경우가 있습니다. 기본 응답 대기 시간은 100초이며 상품 특성에 따라 다를 수 있습니다. |
| Endpoint | CODEF는 API 상품에 따라 엔드포인트(Endpoint)를 다르게 제공합니다.현재 지원하는 API 상품 엔드포인트에 관한 내용은 개발 가이드 - 상품 탭에서 자세히 확인하실 수 있습니다. |
| API Host | CODEF는 회원 단계에 따라 API Host를 다르게 제공합니다.Starter(샌드박스)는 요청 횟수에 제한이 없으며 테스트 데이터만 지원합니다. 모든 CODEF 회원이 사용할 수 있습니다. Developer(데모버전)는 CODEF API를 하루 최대 100회를 사용할 수 있습니다. Business , Partner(정식버전)는 CODEF API 사용에 횟수 제한이 없습니다.회원 단계에 관한 자세한 내용은 코드에프 메인에서 가격 정책 페이지를 확인하세요. |
| API Protocol | CODEF API는 모든 응답은 표준 JSON으로 제공합니다. 또한 데이터 보안을 위해 HTTPS TLS v1.2+로 제공합니다. TLS 1.1 버전 이하 HTTP 및 HTTPS는 지원하지 않습니다. |
| HTTP Header | HTTP 헤더(Header)에는 웹 서버로 보내는 요청과 요청 데이터를 설명하는 메타 정보가 있습니다. 즉, 메서드가 무엇인지 요청 URL이 무엇인지에 관한 정보와 HTTP 프로토콜 버전 등이 들어 있습니다. 추가로 지정된 이름과 값을 전송할 수 있습니다. |
| URL Encoding | 한글이나 특수 문자가 요청 변수의 값에 포함되면 서버로 요청 시 값이 깨지기 때문에 지정된 규칙에 따라 문자를 코드로 변환해서 전송합니다. 이 변환을 URL 인코딩(Encoding)이라고 합니다. 그리고 URL 인코딩이 적용된 값을 다시 원래 값으로 변환하는 것을 URL 디코딩(Decoding)이라고 합니다. |
| Access Token | accessToken은 CODEF 홈페이지에 회원 가입 후 서비스 등록을 신청하면, 키 관리에서 확인할 수 있는 clientId, clientSecret 등 2개 키값으로 생성할 수 있습니다. CODEF API를 이용할 때는 clientId, clientSecret으로 발급받은 accessToken을 HTTP 헤더에 포함해 전송해야 합니다. |
| Connected ID | 커넥티드 아이디(Connected ID)는 인증이 필요한 API 요청 시 사용되는 가장 중요한 키값 중 하나이며, 로그인 정보(인증서, ID/PW)를 식별하기 위해 발급되는 키값입니다. |
| Client | CODEF API를 활용해 애플리케이션을 만드는 대상을 클라이언트(Client)라고 부릅니다. 클라이언트가 만든 애플리케이션을 엔드 유저가 사용합니다. |
| End User | CODEF API를 사용한 애플리케이션을 이용하는 최종 사용자(개인 또는 기업)를 엔드 유저(End User)라고 합니다. 엔드 유저는 웹 브라우저, 모바일 애플리케이션 등으로 클라이언트 애플리케이션에 접속합니다. |
| Key | CODEF 홈페이지에 회원 가입 후 서비스 등록을 신청하면, 마이페이지-키관리 탭에서 clientId, clientSecret, publicKey 등 CODEF API 사용에 필요한 키를 확인할 수 있습니다. |
| Request URL | CODEF API를 호출하기 위한 API URL을 의미합니다. CODEF API URL 형식은 다음과 같습니다. - https://api.codef.io/버전코드/국가코드/업무구분코드/기관고객구분/상품 |
| Public Key | RSA 암호화시 필요한 키로, 마이페이지 - 키 관리 탭에서 확인할 수 있습니다. RSA 암호화는 계정 정보 등록, 빠른 계좌 거래내역 API 등에서 사용합니다. |
| 샌드박스 | 샌드박스를 활용하면 실제 계정 없이 CODEF API를 테스트할 수 있습니다. 샌드박스는 CODEF 모든 회원 등급에서 사용할 수 있습니다. |
| 다건 요청 | 같은 고객이 요청A, 요청B 등 건강보험공단 API 2개 호출 시 요청 식별 아이디를 같은 값으로 넣을 경우 추가 인증 1회만으로 요청A, 요청B 등 2개 요청 모두 응답 받을 수 있습니다. |
| 단건 요청 | 코드에프 API는 1개 요청 1개 응답을 원칙으로 합니다. |
| 로그인 세션 | 로그인 세션은 요청A 추가인증 완료 후 2차 요청 성공 시 생성됩니다. 요청A 응답 결과 후 요청B가 없을 경우 코드에프 서버는 요청A 로그인 세션을 종료합니다. |
| 특수 파라미터 | 기본적인 상품 소개 페이지의 파라미터 이외에 사용자가 원하는 경우 특수 파라미터를 활용해 원하는 형태의 요청을 보낼 수 있습니다. |
| Request Parameter | 요청 파라미터(Request Parameter)는 CODEF API 호출 시 함께 서버로 전송하는 값입니다. |
| API | API(Application Programming Interface)는 운영체제나 시스템, 애플리케이션, 라이브러리 등을 활용해 응용프로그램 작성을 돕는 다양한 인터페이스를 의미합니다. |
반응형