Klucz API pozwala Twojemu własnemu oprogramowaniu komunikować się z platformą przez REST API, na przykład odczytywać członków, zapisywać kogoś na kurs albo podłączyć witrynę WordPress. Każdy klucz to tajne hasło dla programu, więc dla każdego klucza decydujesz, co może robić, i w każdej chwili możesz go zastąpić albo usunąć.
Kto może zarządzać kluczami API
API znajdziesz w bloku Integracje i API menu ustawień. Twoja rola potrzebuje uprawnienia Zarządzaj kluczami API oprócz Zaktualizuj ustawienia platformy. Tego uprawnienia nigdy nie można nadać roli niestandardowej, więc pracować tu mogą tylko wbudowane role Właściciel i Admin. To samo uprawnienie otwiera też Aplikacje OAuth i Logowanie jednokrotne.
Dostęp do API zależy od Twojego planu. Jeśli Twój plan go nie obejmuje, strona pokazuje „Dostęp do API jest częścią każdego płatnego planu. Zmień plan, aby tworzyć klucze API.” razem z przyciskiem Zmień plan, a Nowy klucz API pozostaje nieaktywny. Istniejące klucze API odrzuca, dopóki plan znów nie obejmie dostępu.
Tworzenie klucza
Kliknij Nowy klucz API. Otworzy się okno Utwórz klucz API.
- Wpisz w polu Nazwa coś, co później powie Ci, kto używa klucza, na przykład narzędzie albo witrynę, do której należy. Nazwa jest wymagana.
- Zdecyduj, co klucz może robić. Nowy klucz zaczyna z pełnym dostępem, więc wszystkie uprawnienia są zaznaczone.
- Kliknij Utwórz.
Aby ograniczyć klucz, kliknij Ogranicz do wybranych uprawnień. Wszystkie uprawnienia zostaną odznaczone, a Ty wybierasz te, których potrzebujesz. Uprawnienia są pogrupowane według obszarów, takich jak Członkowie, Grupy, Kursy czy Płatności, a każdy obszar wymienia akcje, na przykład Zobacz albo Zarządzaj, z krótkim opisem. Zaznacz wszystko i Odznacz wszystko przełączają cały obszar naraz. Licznik pokazuje, ile uprawnień ma klucz. Klucz potrzebuje co najmniej jednego uprawnienia, a Przywróć pełny dostęp ponownie zaznacza wszystkie.
Po kliknięciu Utwórz okno Twój nowy klucz API pokazuje pełny klucz jeden raz. Skopiuj go i przechowuj w bezpiecznym miejscu. Potem lista pokazuje już tylko ostatnie cztery znaki i nikt nie może ponownie wyświetlić pełnego klucza.
Używanie klucza
Pole Dokumentacja API nad listą pokazuje Bazowy URL API z przyciskiem kopiowania, a Otwórz dokumentację prowadzi do interaktywnej dokumentacji ze wszystkimi endpointami.
Wysyłaj klucz z każdym żądaniem, jako Bearer token w nagłówku
Authorization albo w nagłówku X-Api-Key. Klucze zaczynają się od mak_.
Żądanie, które wymaga uprawnienia, którego klucz nie ma, zostaje odrzucone.
Klucz jest powiązany z członkiem zespołu, który go utworzył. Jeśli ta osoba nie należy już do Twojego obszaru roboczego, klucz przestaje działać, więc klucze do długotrwałych połączeń twórz na koncie, które zostanie.
Lista pokazuje każdy klucz z kolumnami Nazwa, Klucz, Ostatnie użycie i Utworzono. Ostatnie użycie aktualizuje się najwyżej raz na minutę, co wystarcza, aby sprawdzić, czy klucz jest nadal używany.
Zmiana, odnawianie i usuwanie klucza
Kliknij klucz na liście albo użyj Edytuj, ikony ołówka w jego wierszu, aby zmienić nazwę lub uprawnienia. Zmiany zaczynają obowiązywać po kliknięciu Zapisz.
Jeśli klucz mógł wyciec, odnów go. Odnów klucz w tym samym oknie pyta: „Odnowić ten klucz? Stary sekret natychmiast przestanie działać, a zewnętrzne integracje będą potrzebować nowego.” Po potwierdzeniu nowy klucz pojawia się jeden raz w oknie Twój nowy klucz API. Nazwa i uprawnienia pozostają bez zmian, a Ostatnie użycie liczy się od nowa. Wpisz nowy klucz w każdym narzędziu, które używało starego.
Aby usunąć klucz, użyj Usuń, ikony kosza w jego wierszu, albo Usuń w otwartym oknie, i potwierdź. Od tej chwili każde narzędzie, które nadal go używa, zostaje odrzucone.
Aplikacje OAuth, logowanie jednokrotne i webhooki
Wklejenie klucza to nie jedyny sposób połączenia:
- Aplikacje OAuth pozwalają innym MemberAreas łączyć Twoje oprogramowanie przez OAuth zamiast wklejonego klucza API.
- Logowanie jednokrotne loguje członków z innego systemu. Opisuje je artykuł Logowanie, rejestracja i SSO.
- Webhooki dla zdarzeń członków i płatności mają własną stronę w Ustawienia > Webhooki, która pojawia się po włączeniu Płatności.