Node API Key
멀티체인 환경 API 사용 시 인증을 위한 API Key의 발급 및 관리 방법에 대해 알아봅니다.
Node API Key로는 무엇을 할 수 있나요?
퍼블릭 체인과 루니버스 메인넷, 사이드체인에 모두 사용 가능한 Multichain Web3 API를 사용하고자 하는 경우 Node API Key 발급이 필요합니다.
Node API Key 발급 방법
이더리움, 루니버스 메인넷 등 다양한 메인넷 환경을 대상으로 한 Multichain Web3 API 전용 API Key 발급 방법을 알아보겠습니다.
- API를 호출하고자 하는 Node를 생성하고, 그림 1과 같이 해당 Node의 상세 화면으로 진입하세요. 여러 탭 중 "Key Management" 탭을 클릭합니다.
그림 1. Node 생성 상세 화면
- [+Create Key] 버튼을 클릭하여 그림 2의 화면으로 이동한 뒤 새로운 API Key를 생성할 수 있습니다.
- 멀티체인 Web3 API 호출을 위한 API Key 생성 화면에서는 각 도메인들에 대한 접근 권한을 설정하실 수 있습니다. Key의 Title을 설정한 뒤, 각 도메인에 대해 원하는 접근 권한을 선택하세요.
All Permission: 읽기, 쓰기를 포함한 모든 API 권한입니다.
Read-Only: 읽기 전용 권한입니다. 트랜잭션 제출 등 쓰기 권한이 필요한 API의 사용이 제한될 수 있습니다.
그림 2. API Key Creation 화면
- 권한 설정 완료 후 [Create] 버튼을 누르면, 해당 권한이 부여된 API Key가 생성 완료됩니다. 그림 4와 같이 API Key의 Key ID와 Key Secret이 보여지는 화면에서, API Key Secret값을 복사 또는 다운로드 하고 안전하게 보관하세요.
Key Secret은 생성 단계에서 꼭 복사하고, 안전하게 저장하세요.
Api Key Secret의 경우, 해당 단계에서만 노출 되며 이후 API Key 목록 등에서 확인이 불가합니다. 만약 Api Key Secret을 별도로 복사, 저장하지 않고 해당 페이지를 벗어나는 경우 해당 API Key는 사용이 불가하여 새로운 Key를 다시 생성해야 하는 문제가 발생합니다. Api Key Secret은 복사 후 API 인증 토큰 발급을 수행할 서버 내 설정 파일 등에 저장하여 관리하되, 값이 직접적으로 외부로 노출되어 잘못 사용되지 않도록 별도의 문자열 암호화 또는 파일 접근 권한 관리를 통해 보안에 주의해주시기 바랍니다.
그림 4. API Key 생성 완료 화면
이제 멀티체인 Web3 API 를 호출하기 위한 API Key 생성이 완료되었습니다! Api Key ID 값과 Api Key Secret 값을 활용하여 인증 토큰을 생성하는 Auth API를 호출할 수 있습니다.
Node API Key 삭제
Node API Key 목록 화면에서 삭제하고자 하는 대상 API Key를 확인합니다. 삭제 대상 API Key의 우측 휴지통 모양의 삭제 아이콘을 클릭합니다. 최종 삭제 확인 팝업에서 삭제 내용을 확인한 뒤, [Yes, I'm sure]을 클릭하면 최종 삭제가 완료됩니다.
사용중인 API Key를 삭제하지 않도록 유의하세요.
특정 API Key로부터 발급된 인증 토큰을 통해 실제 API 호출하고 있는 도중 해당 API Key를 삭제하는 경우, 그로부터 발급된 하위 인증 토큰들도 모두 사용이 불가해집니다. 루니버스와 연동하여 서비스를 제공하고 있는 경우 API Key 삭제에 유의해주세요.
Updated 4 months ago