Open Cloud는 API 키를 사용하여 API 액세스를 인증하고 권한을 부여하며, 데이터 저장소 및 장소와 같은 특정 리소스에 액세스하는 데 세분화된 권한을 부여할 수 있습니다.
모든 개방형 클라우드 API는 유효한 권한을 가진 API 키를 생성하고 요청에 x-api-key 헤더를 포함하여 애플리케이션이 대신 개방형 클라우드에 인증할 수 있도록 합니다.
API 키 생성
개인적으로 소유한 경험 또는 그룹 소유 경험에 대해 API 키를 생성하고 구성할 수 있습니다(Roblox 그룹 그룹은 여러 명의 크리에이터가 동일한 경험에 작업하고 동일한 자산을 사용하고 API 키를 공유할 수 있습니다).
그룹 소유자 또는 그룹 내에서 역할을 할당받은 그룹 구성원이 API 키 관리자 권한이 있는 그룹의 일부여야 그룹에 대한 API 키를 생성할 수 있습니다. 그룹 구성원은 역할 내에서 동일한 리소스 액세스 권한을 가진 그룹 키만 생성할 수 있습니다.
API 키를 생성하려면:
크리에이터 대시보드로 moves.
(옵션) 그룹을 생성하는 경우 크리에이터 허브 드롭다운을 클릭하여 그룹을 선택하십시오.
왼쪽 탐색 메뉴에서 클라우드 열기 → API 키를 선택합니다.
클릭하십시오 API 키 생성 버튼 .
API 키에 고유한 이름을 입력하십시오. 나중에 목적을 확인할 수 있도록 하는 이름과 같은 이름을 사용하십시오. 예를 들어, PLACE_PUBLISHING_KEY 는 장소를 경험에 게시하는 데 사용됩니다.
In the 액세스 권한 section, select an API from the 액세스 API 시스템 menu and click the API 시스템 추가 button. Repeat this step if you need to add multiple APIs to the 키.
API 키로 액세스할 경험을 선택하십시오.
경험 작업 드롭다운에서 API 키를 활성화하려는 작업 을 선택하세요.
많은 작업에서 API 참조에 필요한 권한 범위가 포함되어 있습니다. 예를 들어, 메모리 스토어 플러시 작업에는 universe.memory-store:flush 권한이 필요합니다.
In the 보안 section, explicitly set IP access to the key using CIDR notation , otherwise you can't use the API 키. You can find the IP address of your local 환경and add it to the 허용된 IP 주
(옵션) : 자원에 추가 보호를 추가하려면 명시적 만료 날짜를 설정하여 키가 해당 날짜 이후에 자동으로 작동을 중지합니다.
클릭하십시오 Save and Generate key 버튼.
코드의 공개 저장소가 아닌 안전한 위치에 API 키 문자열을 복사하고 저장하십시오.
크리에이터 대시보드의 크리에이터 섹션에서 생성된 API 키를 확인하십시오.
그룹 소유 API 키 권한
그룹 소유자는 그룹 회원이 API 키를 기반으로 다양한 수준의 API 키 제어를 가질 수 있도록 그룹 소유 API 키 권한을 관리할 수 있습니다. 그룹 회원에게 역할 및 권한에 따라 API 키 관리 권한을 자동으로 취소하는 경우도 있습니다.
권한 부여
그룹 소유자로서, 그룹 내 역할에 대한 모든 API 키 관리 권한을 부여할 수 있습니다. 이 권한을 가진 회원은 그룹 소유자가 그룹 키에 대한 모든 권한을 포함하여 그룹 키를 생성, 보기, 취소, 검토 및 검증할 수 있는 모든 권한을 가집니다.
그룹 내의 역할에게 자체 API 키 관리 권한을 부여하는 것도 가능합니다. 이를 통해 회원은 다른 사람의 키를 관리할 수 없으며 자신의 키만 생성하고 보여줄 수 있습니다.
권한 무효
그룹 멤버의 권한을 관리하기 위해 그룹을 자동으로 다시 제한하는 여러 상황이 있습니다.
- 구성원은 권한이 없는 다른 역할에 할당됩니다. 이 경우는 그룹 소유권 전송 중에 발생할 수 있습니다.
- 현재 할당된 역할에서 멤버의 권한이 비활성화되었습니다.
- 그룹에서 멤버가 나간 또는 제거됩니다.
- 멤버계정은 Roblox에 의해 조정됩니다.
이 중 하나인 경우, 해당 사용자가 생성한 API 키는 취소상태를 가집니다. 이 키를 다시 사용하려면 그룹 소유자 또는 모든 API 키 관리 권한이 있는 회원이 키를 다시 생성해야 합니다.
CIDR 형식
자원을 더 보호하려면, API 키를 생성할 때, 일반 IP 주소로 API 키에 액세스할 수 있는 IP 주소를 지정하거나 CIDR 노트 를 사용하여 API 키에 액세스할 수 있습니다. CIDR IP 주소는 네트워크 라우팅에 대한 IP 주소의 비트 수를 나타내는 슬래시와 10
- 일반 : 192.168.0.0
- CIDR : 192.168.0.0/24
이전 부분은 IP 주소이고 나머지 부분은 네트마스크 입니다. 이 네트마스크는 1의 비트를 이진 형식으로 계산합니다. 이전 예에서 2
API 키 상태
API 키는 처음에 활성 상태이지만 수명 동안 비활성 상태가 될 수 있습니다. 왜 API 키가 상태를 변경했는지 및 API 키를 활성 상태로 다시 반환하는 방법에 대해 알아보려면 다음 표를 참조하십시오.
만약 여러분이나 여러분의 그룹이 API 키를 60일 동안 사용하지 않거나 업데이트하지 않는 경우, 그것은 자동으로 만료됩니다. 이렇게 하면 잘못된 액터가 이전에 설정된 만료 날짜가 없더라도 API 키를 사용하는 위험이 줄어듭니다. 만약 API 키를 더 이상 사용하지 않
상태 | 이유 | 해상도 |
---|---|---|
활동적 | 문제 없음. 사용자는 API 호출을 인증하기 위해 키를 사용할 수 있습니다. | N/A |
비활성화 | 사용자는 키 활성화 버튼을 끄기 토글을 비활성화하여 키를 비활성화했습니다. | 키 활성화 토글 활성화 키를 활성화하십시오. |
만료됨 | 키의 만료 날짜가 지났습니다. | 새 만료 날짜를 설정하거나 제거합니다. |
자동 만료 | 사용자가 지난 60일 동안 키를 사용하거나 업데이트하지 않았습니다. | 키를 비활성화한 다음 키 활성화 토글을 활성화하거나 키의 속성을 업데이트할 수 있습니다, 예를 들어 이름, 설명 또는 만료 날짜입니다. |
취소 | 그룹 키만 해당됩니다. 키를 생성한 계정에는 더 이상 그룹의 키를 관리할 수 있는 충분한 액세스 권한이 없습니다. | 새 비밀번호를 얻으려면 키 재생을 클릭하십시오. |
조정 | Roblox 관리자가 보안 이유로 키의 비밀을 변경했습니다. | 새 비밀번호를 얻으려면 키 재생을 클릭하십시오. |
사용자 조정 | 키를 생성한 계정은 Roblox의 조정을 받습니다. | 계정에 대한 조정 문제를 해결하십시오. |