Zarządzanie kluczami API

Open Cloud uwalnia autoryzację API i upoważnia dostęp do API za pomocą kluczy API, które umożliwiają dodanie granularnych uprawnień i kontroli bezpieczeństwa dla dostępu do niektórych zasobów w Twoim doświadczeniu, takich jak magazyny danych i miejsca.

Wszystkie otwarte API wymagają, abyś stworzył klucz API z ważnymi uprawnieniami i włączył w swoim prośbax-api-key nagłówkę, która umożliwia aplikacji uwierzytelnienie się do Open Cloud na Twoje zlecenie.

Tworzenie kluczy API

Możesz tworzyć i konfigurować klucze API dla swoich osobistych doświadczeń lub doświadczeń grupowych (A Roblox grupa pozwala na współpracę wielu twórców na tej samej eksperyencji, używanie tych samych zasobów i dzielenie się kluczami API).

Musisz być właścicielem lub członkiem grupy, do której przypisano uprawnienia administratora klucza API, aby utworzyć dla swojej grupaklucz API. Członek grupy może tylko utworzyć klucz API z tych samych zasobów dostępu, co jego rola. Na przykład, tylko członkowie grupy z uprawnieniami Utwórz i edytuj doświadczenia grupy mogą utworzyć klucz API,

Aby utworzyć klucz API:

1. Przejdź do Panelu twórcy.

2. (Opcjonalne) Kliknij na menu Utwórz w dolnym pasku, 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 unikalne imię dla klucza API. Użyj imienia, które może Ci pomóc pamiętać cel później, takiego jak PLACE_PUBLISHING_KEY dla publikacji miejsc w swoim doświadczeniu.

6. W sekcji Dostępne uprawnienia wybierz API z menu Wybierz system API i kliknij przycisk Dodaj system API. Powtórz ten krok, jeśli chcesz dodać wiele API do klucza.

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

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

   Wiele operacji w API reference uwzględnia wymaganą zasięg uprawnień. Na przykład operacja przechowywanie pamięci wymaga uprawnienia universe.memory-store:flush.

   Ze względów bezpieczeństwa każdą klucz API należy przypisać minimum wymaganym uprawnieniom. Jeśli klucz API ucieka, zasada najmniejszego uprawnienia zapewnia, że tylko podzespół Twoich zasobów jest kompromitowany.

9. W sekcji Bezpieczeństwo, ustaw wyraźnie dostęp IP do klucza przy użyciu notacji CIDR, w przeciwnym razie nie możesz użyć klucza API. Możesz zn

10. (Opcjonalne) : Aby dodać dodatkową ochronę dla swoich zasobów, ustaw wyraźną datę wygasania, aby twój klucz automatycznie przestał działać po tej dacie.

11. Kliknij przycisk Zapisz i generuj klucz .

12. Kopiuj i zapisz strungę klucz API do bezpiecznej lokalizacji, która nie jest nie publicznym przechowalnicą twojego kodu.

13. Sprawdź swojego stworzonego klucza API na stronie Credits w Creator Dashboard.

Dostępy API Key Groups

Właściciele grup mogą zarządzać uprawnieniami do API grup w taki sposób, aby członkowie grupy mieli różne poziomy kontroli kluczy API w zależności od roli i uprawnień w grupa. Są również sytuacje, w których automatycznie cofnię zezwolenia na zarządzanie kluczami API dla członków grupy.

Dawanie uprawnień

Jako właściciel grupy możesz przyznać Zarządzaj wszystkimi kluczami API uprawnienia dla ról w swojej grupa. Członkowie z tym uprawnieniem mają wszystkie uprawnienia, które posiada właściciel grupy, dla kluczy API, w tym możliwość tworzenia, widzenia, edytowania, cofnięcia i przeglądania wszystkich kluczy API grupa.

Możesz również przyznać zezwolenie na zarządzanie własnymi kluczami API dla ról w swojej grupa. To pozwala członkom tworzyć i wyświetlać klucze należące do nich, a nie być w stanie zarządzać kluczami innych.

Nieprawidłowe uprawnienia

Są kilka sytuacji, w których automatycznie cofnięto zezwolenie członekgrupy na zarządzanie kluczami API grupy:

• Członkowie są przypisani do różnej roli, która nie ma uprawnień. Może to nastąpić podczas przeniesienia własności grupy.
• Zezwolenie członekjest wyłączone w ich obecnie przydzielonej roli.
• Członek opuści lub zostanie usunięty z grupa.
• Konto członekjest moderowane przez Roblox.

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

Format CIDR

Aby dalej chronić swoje zasoby, gdy tworzysz klucz API, określ adresy IP, które mogą uzyskać dostęp do kluczu API z użyciem dowolnych normalnych adresów IP lub używając notacji CIDR IP. Adresy IP CIDR wyglądają jak normalne adresy IP, z wyjątkiem slasza i dziesięciu dwunastu znaków, które reprezentują liczbę bit IP adresu są ważne dla sieci routingu sieci:

• Normalny : 192.168.0.0
• CIDR : 192.168.0.0/24

Starsze część to adres IP, a starsze część to net mask, licząc bity 1s w formie binarnej. W poprzednim przykładzie 24 oznacza 255.255.255.0

Stan klucza API

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