API 키 관리

Open Cloud는 API 키를 사용하여 API 액세스를 인증하고 승인하여 경험에서 데이터 저장소 및 장소와 같은 특정 리소스에 대한 세부적인 권한 및 보안 제어를 추가할 수 있도록 합니다.

모든 오픈 클라우드 API는 유효한 권한으로 API 키를 만들고 요청에 x-api-key 헤더를 포함하여 요청해야 하며, 응용 프로그램이 귀하를 대신하여 Open Cloud에 인증할 수 있도록 합니다.

API 키 생성

개인 소유 경험이나 그룹 소유 경험에 대한 API 키를 생성하고 구성할 수 있습니다(Roblox 그룹은 여러 크리에이터가 동일한 경험에서 작업하고, 동일한 자산을 사용하고, API 키를 공유할 수 있도록 허용함).

그룹 소유자이거나 API 키 관리 권한이 있는 그룹 내 역할에 할당되어야만 그룹에 대한 API 키를 생성할 수 있습니다.그룹 멤버는 역할의 동일한 리소스 액세스 권한으로 API 키를 만들 수만 있습니다.예를 들어, 그룹 경험 생성 및 편집 권한을 가진 그룹 멤버만 장소 파일을 게시할 수 있는 API 키를 만들 수 있습니다.

API 키를 생성하려면:

탐색하여 크리에이터 대시보드로 이동합니다.
(옵션) 클릭하여 크리에이터 허브 드롭다운을 선택하여 그룹을 만드는 경우 API 키를 선택하세요.
왼쪽 탐색 메뉴에서 클라우드 열기 → API 키 를 선택합니다.
클릭하십시오 API 키 생성 버튼.
API 키의 고유 이름을 입력하십시오.경험에 게시 장소를 게시하기 위한 PLACE_PUBLISHING_KEY와 같이 나중에 목적을 기억할 수 있는 이름을 사용하십시오.
액세스 권한 섹션에서 API 선택 시스템 메뉴에서 API를 선택하고 API 시스템 추가 버튼을 클릭하십시오.키에 여러 API를 추가해야 하는 경우 이 단계를 반복하십시오.
API 키로 액세스하려는 경험을 선택합니다.
경험 운영 에서 드롭다운에서 API 키에 대해 활성화하려는 작업을 선택합니다.

API 참조에서 많은 작업에는 필요한 권한 범위가 포함되어 있습니다.예를 들어, 플러시 메모리 저장소 작업에는 universe.memory-store:flush이 필요합니다.

보안상의 이유로 각 API 키에 필요한 최소 권한 수를 부여합니다.API 키가 유출되면 최소 권한 원칙에 따라 리소스의 하위 집합만 손상됩니다.
보안 섹션에서 IP 액세스를 CIDR 표기법을 사용하여 명시적으로 키에 액세스하고, 그렇지 않으면 API 키를 사용할 수 없습니다.로컬 머신의 IP 주소를 찾아 액세스가 필요한 사람들을 위한 추가 IP 주소와 함께 허용된 IP 주소 섹션에 추가할 수 있습니다.고정 IP가 없거나 로컬 환경에서만 API 키를 사용하는 경우, 0.0.0.0/0 섹션에 추가 를 추가하여 모든 IP가 API 키를 사용할 수 있도록 할 수 있습니다.
(옵션): : 리소스에 대한 추가 보호를 추가하려면 명시적인 만료 날짜를 설정하여 해당 날짜 이후에 키 작업이 자동으로 중지됩니다.
클릭하십시오 저장 및 생성 키 버튼.
코드의 공개 리포지토리가 아닌 보안 위치에 API 키 문자열을 복사하고 저장하십시오. Copy and save the API key string to a secure location that is not a public repository of your code.
크리에이터 대시보드의 API 확장 페이지에서 생성된 API 키를 확인하십시오.

API 키 문자열은 응용 프로그램의 비밀번호와 동일합니다.개발 팀 외부의 누군가와 같은 신뢰할 수 없는 파티와 결코 공유하지 마십시오.

그룹 소유 API 키 권한

그룹 소유자는 그룹 소유 API 키 권한을 그룹 멤버가 그룹 내의 역할과 권한에 따라 API 키에 대한 다른 수준의 제어를 갖도록 관리할 수 있습니다.그룹 멤버의 API 키 관리 권한을 자동으로 취소하는 상황도 있습니다.

권한 부여

그룹 소유자로서, 모든 API 키를 관리하는 권한을 그룹 내 역할에 부여할 수 있습니다 모든 API 키 관리 .이 권한을 가진 멤버는 그룹 소유자가 API 키에 가지는 모든 권한을 갖추고 있으며, 그룹의 API 키를 모두 만들고 보고 편집하고 취소하고 감사할 수 있는 능력을 포함합니다.

또한 그룹 내 역할에 자체 API 키 관리 권한 을 부여할 수 있습니다.이렇게 하면 멤버는 다른 사람의 키를 관리할 수 있는 대신 자신이 소유하는 키만 생성하고 볼 수 있습니다.

권한 무효화

그룹 API 키를 관리하는 권한을 자동으로 취소하는 여러 상황이 있습니다.

멤버는 권한이 없는 다른 역할에 할당됩니다. 그룹 소유권 이전 중에 발생할 수 있습니다.
멤버의 권한은 현재 할당된 역할에서 비활성화됩니다.
멤버가 그룹에서 나가거나 제거됩니다.
멤버의 계정은 Roblox에서 조정 중입니다.

이러한 경우 해당 사용자가 생성한 API 키는 취소 상태 가 부여됩니다.이 키를 다시 사용하려면 그룹 소유자 또는 모든 API 키 관리 권한을 가진 멤버가 키를 재생성해야 합니다.

CIDR 형식

리소스를 보다 보호하려면, API 키 생성 시, 정상적인 IP 주소나 CIDR 표기법을 사용하여 API 키에 액세스할 수 있는 IP 주소를 지정하십시오.CIDR IP 주소는 슬래시와 네트워크 라우팅에 중요한 IP 주소 비트 수를 나타내는 10진수로 끝나는 일반 IP 주소와 비슷합니다.

일반 : 192.168.0.0
CIDR : 192.168.0.0/24

이전 부분은 IP 주소이고 나머지 부분은 1의 비트를 이진 형식으로 계산하는 네트워크 마스크 입니다.이전 예제에서 24 는 255.255.255.0 (24 1초)를 의미하며, 이는 192.168.0.0 과 192.168.0.255 사이의 모든 IP를 허용합니다.CIDR 형식을 이해하는 것은 서버에서 애플리케이션을 실행할 계획이 있는 경우 특히 유용합니다.

API 키 상태

API 키는 처음에 활성 상태이지만 수명 동안 비활성화될 수 있습니다.API 키가 상태가 변경된 이유와 API 키를 활성 상태로 되돌리는 방법을 알아보려면 다음 표를 참조하십시오.

당신이나 그룹이 60일 동안 API 키를 사용하거나 업데이트하지 않으면 자동으로 만료되며, 만료 날짜가 설정되지 않았더라도 마찬가지입니다.이렇게 하면 오래된 API 키를 사용하는 악의적인 행위자의 위험이 줄어듭니다.더 이상 API 키를 사용하지 않는 경우 수동으로 비활성화하거나 삭제해야 합니다.

상태	이유	해상도
활성	문제 없음. 사용자는 키를 사용하여 API 호출을 인증할 수 있습니다.	N/A
비활성화됨	사용자가 키 활성화 비활성화 토글을 비활성화하여 키를 비활성화했습니다.	키 활성화 토글을 활성화하십시오.
만료됨	키의 만료 날짜가 지났습니다.	새 만료 날짜를 제거하거나 설정하십시오.
자동 만료	사용자는 지난 60일 동안 키를 사용하거나 업데이트하지 않았습니다.	그런 다음 키 활성화 토글을 비활성화하거나 키의 이름, 설명 또는 만료 날짜와 같은 속성을 업데이트할 수 있습니다.
취소됨	그룹 키만 사용합니다. 키를 생성한 계정에는 더 이상 그룹의 키를 관리할 충분한 액세스 권한이 없습니다.	새로운 비밀을 얻으려면 재생성 키를 클릭하십시오.
조정됨	Roblox 관리자가 보안상의 이유로 키의 비밀을 변경했습니다.	새로운 비밀을 얻으려면 재생성 키를 클릭하십시오.
사용자 조정됨	키를 생성한 계정은 Roblox에서 조정 중입니다.	계정의 조정 문제를 해결합니다.