Data ostatniej aktualizacji: listopada 9, 2021
Dzięki kluczowi API HubSpot programiści mogą tworzyć niestandardowe aplikacje za pomocą interfejsów API HubSpot
. Każdy klucz jest przypisany do konta HubSpot, a nie do pojedynczego użytkownika, i tylko jeden klucz jest dozwolony w tym samym czasie.Uwaga: jeśli planujesz utworzyć wiele aplikacji lub chcesz mieć bardziej szczegółową kontrolę nad zakresami swoich aplikacji, możesz utworzyć aplikację prywatną zamiast używać jednego klucza API do wszystkich swoich aplikacji. Każda prywatna aplikacja ma swój własny token dostępu, który jest zaimplementowany na szczycie OAuth. Dowiedz się więcej o prywatnych aplikacjach w dokumentacji dla programistów HubSpot
.Uzyskaj dostęp do swojego klucza API
Musisz mieć uprawnienia Super Admin
, aby uzyskać dostęp do klucza API swojego konta.- W koncie HubSpot kliknij ikonę ustawień w głównym panelu nawigacyjnym.
- W menu lewego paska bocznego przejdź do zakładki Integracje > Klucz API.
- Jeśli klucz nigdy nie został wygenerowany dla Twojego konta, kliknij Generate API klucz.
- Jeśli klucz API został już wygenerowany, kliknij Pokaż, aby wyświetlić klucz.
- Po wyświetleniu klucza kliknij Kopiuj, aby go skopiować. Możesz następnie wkleić klucz, aby przekazać go swoim programistom lub użyć go w swoich aplikacjach.
Zmień swój klucz API
Udostępnienie klucza API programiście daje mu pełny dostęp do wprowadzania zmian na Twoim koncie za pośrednictwem interfejsu API HubSpot, w tym odczytywania zalogowanych wiadomości e-mail z połączonych kont e-mail i innych danych stron trzecich.
W celu zwiększenia bezpieczeństwa warto rozważyć rotację klucza API HubSpot co sześć miesięcy. Rotacja klucza API HubSpot spowoduje dezaktywację istniejącego klucza API i wygenerowanie nowego. HubSpot wyświetli informacje o wieku klucza API i zaleci, kiedy należy go zmienić.
Przypomnienia o konieczności rotacji klucza API będą wysyłane do Super Adminów i użytkowników, którzy ostatnio utworzyli lub rotowali klucz API, w następujących częstotliwościach i typach powiadomień:
- Gdy klucz API ma pięć miesięcy, wysyłane są powiadomienia e-mail.
- Gdy klucz API ma sześć miesięcy, wysyłane są powiadomienia na pasek boczny.
- Jeśli klucz API nie został obrócony w ciągu sześciu miesięcy, zarówno powiadomienia e-mail, jak i powiadomienia na pasku bocznym będą wysyłane co sześć miesięcy.
Chociaż może to spowodować przestoje i wymagać wysiłku, dodaje warstwę bezpieczeństwa, uniemożliwiając złośliwym aplikacjom dostęp do informacji HubSpot za pomocą istniejącego klucza API.
Aby obrócić klucz API HubSpot:
- Na swoim koncie HubSpot kliknij ikonę ustawień na głównym pasku nawigacyjnym.
- W menu lewego paska bocznego przejdź do pozycji Integracje > Klucz API.
- Kliknij menu rozwijane Akcje, a następnie wybierz opcję Obróć klucz.
- Kliknij przycisk Obróć i wygasić ten klucz teraz. Zaznacz pole wyboru reCAPTCHA. Twój istniejący klucz zostanie dezaktywowany i zostanie utworzony nowy klucz API.
- Kliknij przycisk Kopiuj i zastąp nieaktywny klucz API używany przez Twoje aplikacje tym nowym kluczem API.
Wywołania API przy użyciu dezaktywowanego klucza API HubSpot będą teraz kończyły się niepowodzeniem, a każda aplikacja korzystająca z tego klucza nie będzie już mogła uzyskać dostępu do Twoich informacji.
Zmiana klucza API nie będzie miała wpływu na połączenie z integracją Salesforce
. Jeśli jednak masz zainstalowaną niestandardową integrację, musisz zaktualizować swój klucz API po jego zmianie.Uwaga: rotacja klucza API nie będzie miała wpływu na połączone aplikacje zainstalowane za pośrednictwem App Marketplace
.Dezaktywacja klucza API
Dezaktywacja klucza API nie
spowoduje utworzenia nowego klucza. Wywołania interfejsu API przy użyciu dezaktywowanego klucza API HubSpot zakończą się niepowodzeniem, a żadna aplikacja korzystająca z tego klucza nie będzie mogła uzyskać dostępu do informacji o użytkowniku. Aby dezaktywować swój klucz API:- W koncie HubSpot kliknij ikonę ustawień w głównym panelu nawigacyjnym.
- W menu lewego paska bocznego przejdź do zakładkiIntegracje>Klucz API.
- Kliknij menu rozwijaneAkcje.
- KliknijDezaktywuj klucz i kliknijDezaktywuj ten klucz teraz. Zaznacz pole wyboru reCAPTCHA.
Zobacz dziennik audytu API
Możesz wyświetlić datowany dziennik użytkowników, którzy przeglądali, tworzyli lub dezaktywowali klucz API Twojego konta w sekcji Dziennik audytu.
- W koncie HubSpot kliknij ikonę ustawień w głównym panelu nawigacyjnym.
- W menu lewego paska bocznego przejdź do Integrations > Klucz API.
- Kliknij kartę Dziennik audytu.
Wyświetl dziennik wywołań klucza API
Aby pomóc w usuwaniu błędów w integracji lub upewnić się, że postępujesz zgodnie z zasadami Wytyczne HubSpot dotyczące korzystania z interfejsu APImożna wyświetlić dziennik połączeń z kluczem API z ostatnich 7 dni.
- W koncie HubSpot kliknij ikonę ustawień w głównym panelu nawigacyjnym.
- W menu lewego paska bocznego przejdź do pozycji Integracje > Klucz API.
- W zakładce Dziennik połączeń przejrzyj całą aktywność z ostatnich 7 dni.
