Zarządzaj kluczami API

Open Cloud uwierzytelnia i autoryzuje dostęp do API za pomocą kluczy API, które pozwalają dodawać granularne uprawnienia i kontrolę bezpieczeństwa do uzyskiwania i wykorzystywania określonych zasobów w swoim doświadczeniu, takich jak magazyny danych i miejsca.

Wszystkie otwarte chmurkowe API wymagają utworzenia klucza API z ważnymi uprawnieniami i uwzględnienia nagłówka x-api-key w prośba, który pozwala aplikacji uwierzyć w Open Cloud w Twoim imieniu.

Twórz klucze API

Możesz tworzyć i konfigurować klucze API dla indywidualnie posiadanych doświadczeń lub doświadczeń należących do grupy (grupę Roblox pozwala na pracę nad tym samym doświadczeniem, wykorzystanie tych samych zasobów i dzielenie kluczy API).

Musisz być właścicielem grupy lub przypisany do roli w grupie, która ma uprawnienie administratora klucza API, aby utworzyć klucz API dla twojej grupa.Członek grupy może utworzyć klucz API tylko z tymi samymi uprawnieniami dostępu do zasobów ich roli.Na przykład tylko członkowie grupy z uprawnieniem Twórz i edytuj doświadczenia grupowe mogą utworzyć klucz API, który może opublikować plik miejsca.

Aby utworzyć klucz API:

1. Przejdź do Pulpitu nawigacyjnego twórcy.

2. (Opcjonalnie) Kliknij menu rozwijane Centrum twórców , aby wybrać grupę, jeśli tworzysz klucz API dla grupa.

3. W lewym menu nawigacji wybierz Otwórz chmurę → Klucze API .

4. Kliknij przycisk Utwórz klucz API .

5. Wpisz unikalną nazwę dla klucza API.Użyj nazwy, która może pomóc ci później przypomnieć cel, takiej jak PLACE_PUBLISHING_KEY dla miejsc publikacji do twojego doświadczenia.

6. W sekcji Uprawnienia dostępu , wybierz API z menu Wybierz system API i kliknij przycisk Dodaj system API .Powtórz ten krok, jeśli musisz dodać wiele API do klucza.

7. Wybierz doświadczenie, do którego chcesz uzyskać dostęp za pomocą klucza API.

8. Z menu rozwijanego Operacje doświadczeń , wybierz operacje, które chcesz włączyć dla klucza API.

   Wiele operacji w referencji API obejmuje wymagane zakresy uprawnień.Na przykład operacja przepłukiwania pamięci przechowywania wymaga uprawnienia universe.memory-store:flush.

   Ze względów bezpieczeństwa, nadaj każdemu kluczowi API minimalną liczbę wymaganych uprawnień.Jeśli klucz API wycieka, zasada minimalnej uprzywilejowania zapewnia, że tylko część twoich zasobów jest zagrożona.

9. W sekcji Bezpieczeństwo , wyraźnie ustaw dostęp IP do klucza za pomocą notacji CIDR, w przeciwnym razie nie możesz używać klucza API.Możesz znaleźć adres IP swojej lokalnej maszyny i dodać go do sekcji Akceptowane adresy IP wraz z dodatkowymi adresami IP dla tych, które potrzebują dostępu.Jeśli nie masz stałego adresu IP lub używasz klucza API tylko w lokalnym środowisko, możesz po prostu dodać 0.0.0.0/0 do sekcji Akceptowane adresy IP , aby umożliwić używanie każdego adresu IP do klucza API.

10. (Opcjonalnie) : Aby dodać dodatkową ochronę dla swoich zasobów, ustaw wyraźną datę wygaśnięcia, tak aby klucz automatycznie przestał działać po tej dacie.

11. Kliknij przycisk Zapisz i wygeneruj klucz .

12. Kopiuj i zapisz stronę klucza API do bezpiecznej lokalizacji, która nie jest publicznym repozytorium kodu.

13. Sprawdź klucz API utworzony na stronie Rozszerzenia API na stronie Pulpitu nawigacyjnego twórcy .

Uprawnienia klucza API własności grupy

Właściciele grup mogą zarządzać uprawnieniami kluczy API należącymi do grupy, aby członkowie grupy mieli różny poziom kontroli kluczy API w oparciu o role i uprawnienia w grupa.Istnieją również sytuacje, w których automatycznie cofane są uprawnienia do zarządzania kluczami API dla członków grupy.

Udzielanie uprawnień

Jako właściciel grupy możesz przyznać Zarządzaj wszystkimi kluczami API uprawnienie rolom w twojej grupa.Członkowie z tym uprawnieniem mają wszystkie uprawnienia, które posiada właściciel grupy dla kluczy API, w tym możliwość tworzenia, odbierać, odwoływać, edytowania, cofania i audytowania wszystkich kluczy API grupa.

Możesz również przyznać uprawnienie Zarządzaj własnymi kluczami API rolom w twojej grupa.Umożliwia to członkom tworzenie i wyświetlanie kluczy, które są w ich posiadaniu, a nie zarządzanie kluczami innych.

Weryfikacja uprawnień

Istnieje wiele sytuacji, które automatycznie cofają uprawnienie członekgrupy do zarządzania kluczami API grupy:

• Członek jest przypisany do innej roli, która nie ma uprawnień. Może to się zdarzyć podczas przeniesienia własności grupy.
• Prawo członekjest wyłączone w obecnie przydzielonej roli.
• Członek opuszcza lub jest usuwany z grupa.
• Konto członekjest moderowane przez Roblox.

W każdym z tych przypadków klucze API generowane przez tego użytkownika otrzymują status Odwołany .Aby ponownie użyć tych kluczy, właściciel grupy lub członek z uprawnieniem Zarządzaj wszystkimi kluczami API musi odregenerować klucze.

Format CIDR

Aby dalej chronić swoje zasoby, gdy tworzysz klucz API, określ adresy IP, które mogą uzyskać dostęp do klucza API za pomocą normalnych adresów IP lub za pomocą notacji CIDR.Adres IP CIDR wygląda jak zwykły adres IP, z wyjątkiem tego, że kończy się spacjią i dziesiętnością, która reprezentuje liczbę bitów adresu IP, które są istotne dla routowania sieciowego:

• Normalny : 192.168.0.0
• CIDR : 192.168.0.0/24

Poprzednia część to adres IP, a ostatnia część to netmask , licząca bity 1s w formacie binarnym.W poprzednim przykładzie 24 oznacza 255.255.255.0 (24 1s), który pozwala na wszystkie IP między 192.168.0.0 a 192.168.0.255 .Zrozumienie formatu CIDR jest szczególnie przydatne, jeśli planujesz uruchomić aplikacje na serwerze.

statusklucza API

Klucze API początkowo mają aktywny stan, ale mogą stać się nieaktywne w ciągu ich życia.Aby dowiedzieć się, dlaczego klucz API zmienił status i jak zwrócić klucz API do aktywnego stanu, zobacz następujący tabelę.