사이트 우측 상단의 "회원가입” 버튼을 클릭하여 개발자 사이트의 아이디를 생성하세요.
(오픈API개발자사이트 내 일부 메뉴는 접근권한 확인이 필요합니다.)
회원가입 후 등록하신 이메일로 안내메일이 발송됩니다.메일 내용의 “활성화”버튼을 클릭 후 개발자사이트로 이동하여 로그인하세요.
“활성화”버튼을 클릭하지 않으시면 로그인이 허용되지 않습니다.
서비스 신청
로그인 후 우측 상단 "MY PAGE"를 클릭 후 "마이페이지-내 서비스 관리" 메뉴를 통해 금융결제원에서 제공하는 서비스를 확인하고 이용 희망 서비스를
신청합니다.
이용 신청이 완료되면 신청 버튼이 사라지고 “이용 중”으로 상태가 전환됩니다.
API Key
서비스별 API를 호출하기 위해서는 API 키를 발급받으셔야 합니다.
API 키는 특정 길이 이상의 키 문자열로 구성되며, 클라이언트 아이디(ID: client_id)와 비밀번호(Secret: client_secret)로
구성됩니다.
"마이페이지 - API Key 관리" 메뉴에서 API Key를 발급받을 수 있습니다.
1 . API Key 생성
API Key 관리 화면에 들어오면 Client ID와 Client Secret을 확인할 수 있습니다.
Client Secret은 비밀번호와 동일한 중요 정보이기 때문에 마스킹되어 표기되며 회원계정의 비밀번호를 검증한 후에 확인 할
수 있습니다.
2 . Callback URL(Redirect URL) 등록
OAuth 기반 사용자 인증 시 각 서비스의 서버와 정보를 주고받을 때 사용되는 정보로 API 테스트를 진행하기 전에 필수로
설정되어야 합니다.
Callback URL는 최대 10개까지 등록할 수 있습니다.
3 . 이용 신청한 서비스에 API Key 등록
“내 서비스 관리”메뉴에서 신청한 서비스에 API Key를 각각 등록합니다.
등록 버튼을 통해 등록을 완료하면 “완료”로 상태가 전환됩니다.
테스트 정보 관리
오픈API를 테스트하기 전에 개발자가 사전에 API 요청에 대한 응답 데이터를 등록하고 등록한 데이터를 활용하여 테스트를 수행할 수 있습니다.
서로 상이한 서비스의 특성을 고려하여 테스트 데이터는 서비스 별로 관리합니다.
오픈 API 테스트
서비스 신청, API Key 등록, 테스트 정보 등록을 완료하면 "도구" 메뉴에서 제공하는 REST API 테스트 기능을 활용하여 테스트를 진행하실 수
있습니다.
1 . 토큰발급
오픈 API를 테스트하기 위해서는 접근토큰(Access Token) 발급이 필요합니다.
발급받은 토큰은 정해진 유효기간 동안 사용할 수 있으며, 갱신요청을 통해 유효기간을 연장할 수 있습니다.
2 . REST API 테스트 도구 활용
개발자사이트는 Swagger UI를 적용한 REST API 테스트 도구를 제공합니다.
발급받은 1토큰을 미리 입력할 수 있도록 UI를 제공하고 있으며,
이를 활용하여 손쉽게 2오픈 API를 테스트 하실 수 있습니다.