Api-Docs 사용하기

⚠️ Api-Docs를 사용하기 전, 로그인 후 지갑 생성을 완료한 후 API KEY를 발급 받아야 합니다.
지갑 생성까지 완료하고 아래 단계를 따라주세요.

📌 Api Key 발급받기

회원가입 후, 지갑 생성까지 완료했다면 Api를 호출하기 위해 Api Key를 발급받아야 합니다.

🔎 Api Key란?

Api key는 Api에 대한 액세스를 요청하는 고유 식별자로, 이를 통해 Api 사용 권한 여부를 확인합니다.
따라서 Api를 호출할 때 반드시 Header에 Api key 값을 입력해야 합니다.
Api key를 입력하지 않거나 유효하지 않은 Api key를 입력할 경우 Api를 호출할 수 없습니다.
이 경우 서비스가 중단될 수 있으니 Api key 정보 확인 Api를 사용하여 Api 토큰의 상태를 주기적으로 확인해야 합니다.
Api Key의 유효기한은 1년입니다. 유효기간이 만료되기 전에 새 Key를 발급 받으셔야 합니다.

api키 생성 글로벌 콘솔 탭에서 개발자 도구 탭으로 이동하여 Api Key의 설정하기 버튼을 클릭합니다. 발급받기 버튼을 클릭하면 API KEY를 생성할 수 있는 모달창이 나타납니다.

분류	글로벌 Api key	지갑 Api key
설명	지갑에 상관없이 Api를 호출	특정 지갑에 대해서만 Api를 호출

⚠️ 활성화 된 Key를 기준으로 글로벌 Api Key는 Key 1개, 지갑 Api Key는 지갑별 1개만 생성 가능합니다!

희망하는 API KEY 분류를 선택해주세요.
('지갑'을 선택한 경우) 보유한 지갑 목록이 나타나면, API KEY를 발급받을 지갑을 선택해주세요.
생성하기 버튼을 클릭하면 API KEY가 발급됩니다.

📌 Api Key header 세팅

Api Key까지 발급받았다면 Api Docs를 사용할 준비가 다 되었습니다!
발급받은 Api Key를 Api Docs의 Header 부분에 입력해주세요.

api키 세팅

발급받은 Api Key를 복사한 후 Api Docs의 Header 부분에 복사한 Key를 붙여넣기 합니다.
한번 Header에 Key를 세팅해 놓으면, 페이지 새로고침을 하지 않는 이상 다른 Api Docs 문서로 이동하여도 사라지지 않습니다.

📌 Api Docs 기능 소개 및 사용 방법

api docs 화면 설명

LANGUAGE

희망하는 프로그래밍 언어 및 라이브러리를 선택하면 코드 예제가 변경됩니다.

코드 복사

복사 버튼을 클릭하면 코드 예제가 복사됩니다.

Try It!

Try It! 버튼을 클릭하면 실제 Api를 호출할 수 있습니다. Response 컴포넌트에서 응답값을 확인할 수 있습니다.

Param

Param의 종류는 Query Param, Body Param이 있으며 Type으로는 Integer, String이 있습니다.
각 타입에 맞게 Input 태그가 세팅되어 있으므로 required 여부에 따라 값을 입력해주시면 됩니다.