API Blue używa systemu uwierzytelniania opartego na tokenach.
Nagłówki
Przed wykonaniem jakichkolwiek zapytań, ważne jest, aby skonfigurować nagłówki dla swojego żądania API. Te nagłówki pozostają spójne w wszystkich zapytaniach, wymagając jedynie jednorazowej konfiguracji. Służą do uwierzytelnienia każdego żądania do API.
Wymagane nagłówki to Token-ID i Secret-ID, reprezentowane jako x-bloo-token-id i x-bloo-token-secret odpowiednio.
Dodatkowo, niektóre zapytania mogą wymagać uwzględnienia Company-ID x-bloo-company-id i Project-ID x-bloo-project-id dla bardziej specyficznych operacji.
Możesz dowiedzieć się, jak utworzyć token i sekret w następującym filmie:
Token ID
Token ID to Twój unikalny identyfikator dostępu do API.
Aby rozpocząć korzystanie z naszego API, kliknij na swój profil w prawym górnym rogu, a w menu profilu znajdziesz zakładkę API.
W zakładce API kliknij przycisk "Generuj token":
Podaj nazwę dla tokena i ustaw datę wygaśnięcia, jeśli chcesz. Jeśli ustawisz datę wygaśnięcia, token API automatycznie przestanie działać po tej dacie.
Po wygenerowaniu zostanie wyświetlony Token ID oraz Secret ID. Token ID będzie poprzedzony pat_ dla łatwej identyfikacji.
Secret ID
Secret ID działa jak hasło, zapewniając bezpieczną komunikację z API Blue.
Pamiętaj, że Secret ID jest wyświetlany tylko raz z powodów bezpieczeństwa, więc przechowuj go w bezpiecznym miejscu, aby zachować dostęp do swoich danych przez API. Dla maksymalnego bezpieczeństwa, Blue przechowuje Twój sekret używając haszowania bcrypt, co oznacza, że nawet nasz zespół nie może odzyskać Twojego jawnego sekretu po jego utworzeniu.
Upewnij się, że przechowujesz swój Token ID i Secret ID w bezpiecznym miejscu, ponieważ każdy, kto ma dostęp do tych danych uwierzytelniających, może uzyskać dostęp do Twoich danych w Blue.
Company & Project IDs
Oto film, który pokazuje, jak znaleźć swój identyfikator firmy i identyfikator projektu w Blue:
Firmy są jednostką najwyższego poziomu w Blue. Identyfikatory firm są używane do identyfikacji firmy w Blue. Są używane w API do określenia, z którą firmą chcesz współpracować. ID jest taki sam jak slug firmy w adresie URL, gdy odwiedzasz firmę w Blue:
app.blue.cc/company/{company-id}/
Dla niektórych zapytań i mutacji będziesz musiał podać Project ID. To jest ID projektu, z którym chcesz współpracować. ID jest taki sam jak slug projektu w adresie URL, gdy odwiedzasz projekt w Blue:
app.blue.cc/company/{company-id}/project/{project-id}/