Data ostatniej aktualizacji: czerwca 28, 2023
Dostępne z każdą z następujących podpisów, z wyjątkiem miejsc, w których zaznaczono:
Wszystkie produkty i plany
|
Dzięki kluczowi API HubSpot programiści mogą tworzyć niestandardowe aplikacje z wykorzystaniem interfejsów API firmy HubSpot. Każdy klucz jest przypisany do konta HubSpot, a nie do pojedynczego użytkownika, i tylko jeden klucz jest dozwolony w danym czasie.
Uwaga:od 30 listopada 2022 r. klucze API HubSpot są wycofywane i nie są już obsługiwane. Zamiast tego będziesz musiał uwierzytelnić się za pomocą prywatnego tokena dostępu do aplikacji lub OAuth. Dowiedz się więcej otej zmianie i o tym, jakzmigrować integrację z kluczem API, aby zamiast tego używać prywatnej aplikacji.
Jeśli widzisz na swoim koncie baner o dezaktywacji klucza API:
- Upewnij się, że zmigrowałeś wszystkie dotknięte integracje, a następniedezaktywuj klucz API.
- Aby sprawdzić, czy klucz API konta był używany w ciągu ostatnich siedmiu dni, możeszprzejrzeć historię dziennika połączeń klucza API. Rejestr połączeń nie będzie pokazywał żadnych żądań wykonanych przy użyciu klucza ponad siedem dni temu.
- Aplikacje wymienione nastroniePołączone aplikacje wustawieniach konta nie muszą być migrowane, ponieważ uwierzytelniają się za pomocą protokołu OAuth.
- Klucze API dla programistów są odrębne od standardowych kluczy API HubSpot i nie są wycofywane. Klucze API deweloperów służą do zarządzania ustawieniami związanymi z aplikacjami HubSpot, w tym subskrypcjami APIwebhooks i typamizdarzeń API osi czasu.
Uzyskaj dostęp do swojego klucza API
Aby uzyskać dostęp do klucza API swojego konta, musisz mieć uprawnienia Super Admin.
- Na koncie HubSpot kliknij ikonę ustawień w głównym pasku nawigacyjnym.
- W menu lewego paska bocznego przejdź do Integrations > API key.
- Jeśli klucz nigdy nie został wygenerowany dla Twojego konta, kliknij Generuj klucz API klucz.
- Jeśli już wygenerowałeś klucz API, kliknij Pokaż, aby wyświetlić swój klucz.
- Po wyświetleniu klucza kliknij przycisk Kopiuj, aby go skopiować. Następnie można wkleić klucz, aby przekazać go programistom lub użyć go w swoich aplikacjach.
Obracaj swoim kluczem API
Udostępnienie klucza API programistom da im 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.
Dla zwiększenia bezpieczeństwa warto rozważyć zmianę klucza API firmy HubSpot co sześć miesięcy. Rotacja klucza API HubSpot spowoduje dezaktywację istniejącego klucza API i wygenerowanie nowego. HubSpot wyświetli wiek klucza API i zaleci, kiedy należy go zmienić.
Powiadomienia e-mail są wysyłane co 180 dni do super administratorów i użytkowników, którzy ostatnio utworzyli lub obrócili klucz API, jeśli klucz API nie został obrócony w tym czasie.
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 Integracje > Klucz API.
- Kliknij menu rozwijane Akcje, a następnie wybierz opcję Obróć klucz.
- Kliknij Rotate 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 nieaktywnego klucza API HubSpot zakończą się niepowodzeniem, a każda aplikacja korzystająca z tego klucza nie będzie mogła uzyskać dostępu do informacji.
Zmiana klucza API nie będzie miała wpływu na połączenie z integracją Salesforce. Jeśli jednak masz zainstalowaną niestandardową integrację, będziesz musiał zaktualizować swój klucz API po jego rotacji.
Uwaga: Podłączone aplikacje zainstalowane za pośrednictwem App Marketplace nie będą miały wpływu na rotację klucza API.
Dezaktywuj swój klucz API
Dezaktywacja Twojego klucza API nie spowoduje utworzenia nowego klucza. Wywołania API przy użyciu nieaktywnego klucza API HubSpot zakończą się niepowodzeniem, a każda 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:- Na koncie HubSpot kliknij ikonę ustawień w głównym pasku nawigacyjnym.
- W menu lewego paska bocznego przejdź do opcji Integracje > Klucz API.
- Kliknij menu rozwijane Akcje .
- Kliknij Dezaktywuj klucz i kliknij Dezaktywuj 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.
- Na koncie HubSpot kliknij ikonę ustawień w głównym pasku nawigacyjnym.
- W menu lewego paska bocznego przejdź do Integrations > Klucz API.
- Kliknij kartę Dziennik audytu.
Wyświetlanie dziennika wywołań klucza API
Aby pomóc w usunięciu błędów w jednej z integracji lub upewnić się, że przestrzegasz wytycznych HubSpot dotyczących korzystania z interfejsu API, możesz wyświetlić dziennik wywołań klucza API z ostatnich 7 dni.
- Na koncie HubSpot kliknij ikonę ustawień w głównym pasku nawigacyjnym.
- W menu lewego paska bocznego przejdź do opcji Integracje > Klucz API.
- W zakładce Dziennik połączeń przejrzyj całą aktywność z ostatnich 7 dni.
