Luniverse API Key
루니버스 API 사용 시 인증을 위한 API Key의 발급 및 관리 방법에 대해 알아봅니다.
루니버스 API Key 로는 무엇을 할 수 있나요?
루니버스 API Key는 루니버스 메인넷, 사이드체인에서 제공하는 아래 API들을 호출하기 위한 인증 토큰 생성에 사용됩니다.
루니버스 API Key 사용 대상 API
- 루니버스 메인넷 API
- 루니버스 사이드체인 API
- 루니버스 토큰(FT) API
- 루니버스 NFT API
- 루니버스 Prebuilt 서비스 API (Loyalty Point, Trace, DID)
루니버스 API Key 발급받기
루니버스의 메인넷, 사이드체인, FT 및 NFT, 그리고 Pre-built 서비스를 사용하기 위한 API Key를 발급받는 방법을 알아보겠습니다. 멀티체인 Web3 API 사용을 위한 API Key 발급 방법은 Node API Key를 참고해주세요.
- 루니버스 콘솔 우측 상단의 My Luniverse 메뉴(프로필 이미지)를 클릭하면 보이는 IAM 메뉴를 클릭하여, IAM User 및 API Key를 관리하기 위한 메뉴로 진입합니다.
그림 1. My Luniverse 메뉴 진입
- 그림 2와 같이 "API Key" 탭을 클릭하여 API Key 관리 메뉴로 진입 후 [+ Create API Key] 버튼을 클릭하여 새로운 API Key 발급을 위한 화면으로 이동합니다.
그림 2. IAM/API Key 메뉴 진입 화면
- API Key 생성 과정은 크게 두 단계로 나눠집니다. 첫번째 단계는 API Key의 사용 목적(Purpose)을 입력하고, 해당 Key로 접근하고자 하는 기능에 대한 Permission을 부여하는 단계입니다. 사용 목적은 추후 API Key 목록에서 해당 Key를 구분하는 Title로도 활용됩니다. 그림 3과 같이 해당 API Key에 대한 적절한 사용 권한을 선택했다면, [Create] 버튼을 클릭하세요.
그림 3. Create API Key 화면
- Key 생성이 완료되면 그림 4와 같이 생성된
Access Key와Secret Key값을 확인하실 수 있습니다.
그림 4. API Key 생성 결과
Secret Key는 생성 단계에서 꼭 복사하고, 안전하게 저장하세요.
Secret Key의 경우, 해당 단계에서만 노출 되며 이후 API Key 목록 등에서 확인이 불가합니다. 만약 Secret Key를 별도로 복사, 저장하지 않고 해당 페이지를 벗어나는 경우 해당 API Key는 사용이 불가하여 새로운 Key를 다시 생성해야 하는 문제가 발생합니다. Secret Key는 복사 후 API 인증 토큰 발급을 수행할 서버 내 설정 파일 등에 저장하여 관리하되, 값이 직접적으로 외부로 노출되어 잘못 사용되지 않도록 별도의 문자열 암호화 또는 파일 접근 권한 관리를 통해 보안에 주의해주시기 바랍니다.
발급받은 API Key IP Allowlist 등록
API Key 목록 화면으로 이동 후 해당 API Key를 사용하여 API를 호출할 IP 주소에 대해 허용 IP 목록으로 등록해야 합니다. [+ Register IP Whitelist] 버튼을 클릭하여 새로운 IP 주소를 등록합니다. 단일 IP가 아닌 특정 IP 대역을 사용하시는 경우, CIDR 포맷을 사용하여 해당 대역을 일괄 지정 등록할 수 있습니다.
그림 5. IP 등록을 위한 화면
이제 루니버스 API 를 호출하기 위한 API Key 생성이 완료되었습니다! Access Key 값과 Secret Key 값을 활용하여 허용된 IP주소로부터 인증 토큰을 생성하는 Auth API 요청을 호출할 수 있습니다.
루니버스 API Key 권한 변경
API Key 목록 화면에서 권한을 변경하고자 하는 API Key를 클릭하여 API Key 상세 화면으로 이동합니다.
Permission 메뉴 우측 연필 모양의 수정 아이콘을 클릭하여 권한 편집 모드로 진입합니다.
부여하고자 하는 권한 항목에 대해 체크 또는 체크해제 한 뒤, 설정이 완료되면 [Save] 버튼을 눌러 변경사항을 저장합니다.
루니버스 API Key 삭제
API Key 목록에서 삭제하고자 하는 API Key 정보를 확인한뒤, 해당 Key 항목 우측 휴지통 모양의 삭제 아이콘을 클릭합니다. 삭제 확인 팝업이 뜨면, 삭제 대상이 맞는지 최종 확인하고 [Delete]버튼을 클릭하여 삭제를 완료합니다.
사용중인 API Key를 삭제하지 않도록 유의하세요.
특정 API Key로부터 발급된 인증 토큰을 통해 실제 API 호출하고 있는 도중 해당 API Key를 삭제하는 경우, 그로부터 발급된 하위 인증 토큰들도 모두 사용이 불가해집니다. 루니버스와 연동하여 서비스를 제공하고 있는 경우 API Key 삭제에 유의해주세요.
Updated 5 months ago