Pierwsze kroki w Bluebeam Developer Portal

Gdy zalogujesz się za pomocą poświadczeń BBID za pośrednictwem Okty, portal natychmiast zweryfikuje Twoje uprawnienia. Nie jest wymagane ręczne wdrożenie ani wysyłanie wiadomości e-mail do zespołu ds. Partnerstwa, chyba że jesteś programistą oprogramowania i/lub partnerem.

Wymagania dotyczące subskrypcji

Przy logowaniu portal sprawdza, czy Twoje konto spełnia wszystkie trzy kryteria:

• Prawidłowe konto BBID

• Aktywna Core, Complete lub Max subskrypcja

  • Plan Basics nie kwalifikuje się: Abonenci planu Basics nie mają dostępu do Developer Portal, ponieważ nie mogą użyć opcji Utwórz dla Projektów i Sesji, które są kluczowymi operacjami dla większości integracji. Uaktualnij do planu Core, Complete lub Max, aby uzyskać dostęp.

  • Deweloperzy oprogramowania i partnerzy: Jeśli potrzebujesz specjalnej licencji NFR w ramach Bluebeam Partnerships, musisz poprosić o dostęp do Bluebeam Developer Portal.

• Dopuszczalne regiony: US, AU, DE, UK i SE

Wszystkie nowe aplikacje są domyślnie tworzone w środowisku Sandbox. Sandbox zapewnia dedykowaną przestrzeń do bezpiecznego budowania i testowania integracji, zanim dotrze ona do użytkowników końcowych.

• Poświadczenia środowiska piaskownicy pozostaną spójne, gdy aplikacja zostanie przeniesiona do środowiska produkcyjnego.

• W przypadku przejścia do Produkcji limity stawek zostaną dostosowane na pomoc techniczna ograniczeń użytkowania w świecie rzeczywistym.

• Aplikacje pozostają w środowisku testowym, dopóki jawnie nie zażądasz zatwierdzenia produkcji (zob. Krok 6).

Proces tworzenia aplikacji został przeprojektowany. Formularz Utwórz aplikację wyświetla tylko tereny istotne dla integracji Bluebeam.

Platforma i regiony

1. Przejdź do Moje aplikacje i wybierz Utwórz aplikację.

2. Wybierz instancję API, która odpowiada Twojemu regionowi, gdy utworzysz aplikację:
   

   • US: https://api.bluebeam.com

   • DE: https://api.bluebeamstudio.de

   • AU: https://api.bluebeamstudio.com.au

   • Wielka Brytania: https://api.bluebeamstudio.co.uk

   • SE: https://api.bluebeamstudio.s

   
   

Pola formularza rejestracyjnego

3. Wypełnienie pól formularza rejestracyjnego:

   • Nazwa aplikacji: Wprowadź maksymalnie 90 znaków.

   • Opis: Wprowadź do 300 znaków.

   • Region: Wybierz instancję API Bluebeam dla Twojego regionu.

   • Adres(y) URL przekierowania: Wprowadź wartości oddzielone przecinkami lub naciśnij Enter — portal organizuje je w listę stronicowaną.

   • Testowanie z Postmanem? W przypadku identyfikatora URI przekierowania użyj https://oauth.pstmn.io/v1/callback. Twoja aplikacja produkcyjna będzie używać innego URI.

Notatki dotyczące uwierzytelniania

4. Interfejs API Bluebeam obsługuje tylko następujące opcje wyboru dla typu przydzielenia:

   • Kod autoryzacji: Wszystkie wywołania API używają OAuth 2.0; użytkownicy udzielają aplikacji uprawnień do działania w ich imieniu.

   • Token odświeżania

5. Identyfikator URI przekierowania: Użyj https://oauth.pstmn.io/v1/callback
   Ten identyfikator URI jest specyficzny dla wykonywania wywołań w Postmanie. Alternatywne narzędzia API lub Twoja aplikacja będą wymagać innego identyfikatora URI.

6. Wybierz Utwórz aplikację  , aby przesłać formularz.
   Po przesłaniu formularza otrzymasz wiadomość e-mail marki MuleSoft z tematem: "Rejestracja aplikacji zatwierdzona". Proszę ignoruj wiadomość e-mail. To niepożądany efekt uboczny używania naszego gotowego rozwiązania.

7. Pobierz poświadczenia. Teraz powinna być widoczna nowo utworzona aplikacja na liście (jeśli jej nie widzisz, odśwież przeglądarkę). Kliknij dowolne miejsce w linii aplikacji, a Otwórz stronę szczegółów, na której możesz wyświetlić swój identyfikator klienta i klucz tajny klienta.
   
   

8. Jeśli używasz Postman do testowania, uzyskaj token dostępu przez Postman.

   1. Uzyskaj dostęp do programu Postman za pomocą aplikacji komputerowej lub przeglądarki i Utwórz bezpłatne konto.

   2. Oto skrypt, który możesz zaimportować do Postmana. Ten skrypt to zbiór wszystkich dostępnych wywołań API Bluebeam. W Postmanie, przejdź do Plik > Importuj i upuść skrypt.

   3. Aby uzyskać access_token w aplikacji Postman, wybierz kolekcję Bluebeam API (Tworzenie skryptów x.x.x).

   4. Wybierz kartę Autoryzacja, aby skonfigurować nowy token w Postmanie.
      

      Więcej informacji na temat uwierzytelniania znajdziesz w Przewodniku po uwierzytelnianiu. Przewodnik po uwierzytelnianiu odwołuje się do parametrów żądania; są one znane jako zmienne w Postmanie.
      Możesz albo skonfigurować środowisko w Postmanie, aby utworzyć zmienne dla swojej autoryzacji, albo ręcznie wypełnić wymagane wartości.

      Wymagane ustawienia i wartości w Postmanie:

      • Typ autoryzacji: Musi być OAuth 2.0

      • Typ nadania: Kod autoryzacji

      • Nazwa tokenu: kod

      • Typ nadania: Kod autoryzacji

      • Autoryzowanie za pomocą przeglądarki musi być włączone.

      • URL autoryzacji: https://api.bluebeam.com/oauth2/authorize

      • Adres URL tokena dostępu: https://api.bluebeam.com/oauth2/token

      • Identyfikator klienta: Identyfikator klienta otrzymany podczas procesu rejestracji aplikacji

      • Klucz tajny klienta: Klucz tajny klienta otrzymany podczas procesu rejestracji aplikacji

      • Zakres: Zakresy dla punktów końcowych Studio; wymagany to offline_access

      • Stan: Stan

      • Uwierzytelnianie klienta: Wyślij poświadczenia klienta w treści

   5. Przewiń do dołu i wybierz Uzyskaj nowy token dostępu.
   6. Zaloguj się za pomocą swojego BBID i wybierz Zezwól na dostęp po wyświetleniu monitu. Otrzymasz token, którego możesz użyć w Postmanie, naszej dokumentacji API lub własnym kodzie.

Tabela Moje aplikacje została zaktualizowana o dodatkowe kolumny, dzięki czemu możesz szybko sprawdzić kluczowe szczegóły aplikacji.

• Nazwa: Nazwa utworzonej aplikacji

• Identyfikator klienta: Unikatowy identyfikator używany we wszystkich żądaniach API

• Środowisko: bieżący status (piaskownica, oczekujące lub produkcja)

• Data utworzenia: data utworzenia aplikacji

• Region: region interfejsu API, w którym utworzono aplikację

• Działania: Wybierz, aby dokonać edycji, usunąć, wyświetlić dane uwierzytelniające lub zażądać zatwierdzenia produkcji.

Na dole tabeli wyświetl poprzednie i następne strony, jeśli zarządzasz wieloma aplikacjami.

Punkty końcowe szukaj

Nowy pasek szukaj słów kluczowych umożliwia wyszukiwanie we wszystkich punktach końcowych i parametrach bez przewijania pełnego odniesienia. Wpisz słowo kluczowe (np. sesje, oznaczenia), aby przejść do odpowiedniego punktu końcowego.

Żądanie testu

Każdy punkt końcowy interfejsu API zawiera teraz przycisk żądania testowego. Wybierz go, aby otworzyć panel w przeglądarce, gdzie możesz:

• Wypełnienie parametrów zapytania i treści żądań

• Wykonuj wywołania API na żywo bezpośrednio z dokumentacji

• Widok pełnej odpowiedzi w tekście

• Przełączaj się między językami kodowania (Python, cURL i inne)

Teraz dostępne: punkty końcowe API oznaczeń wyszły z fazy Beta i są dostępne dla wszystkich deweloperów. Nie jest wymagany żaden dodatkowy dostęp.

Po zbudowaniu i przetestowaniu aplikacji w piaskownicy (Sandbox) wybierz opcję Request Production Approval na stronie szczegółów aplikacji w sekcji Moje aplikacje. Powoduje to otwarcie wstępnie wypełnionego formularza wniosku o zatwierdzenie produkcji. Po wypełnieniu formularza zaznacz pole wyboru z zastrzeżeniem i kliknij przycisk Submit for Production Approval. Na koniec potwierdź zgłoszenie.

Po przesłaniu formularza zespół ds. partnerstwa w zakresie integracji wyśle wiadomość e-mail z informacją o stanie w ciągu 5 dni roboczych.

Status aplikacji po zgłoszeniu

• Status aplikacji zmienia się na Oczekujące po przesłaniu wniosku o zatwierdzenie.

• Zespół Integrations Partnerships wyśle do Państwa wiadomość e-mail zawierającą jedną z poniższych aktualizacji statusu:

  • PRODUKCJA – wniosek dotyczący aplikacji został zatwierdzony i przekazany do produkcji

  • OCZEKUJĄCE – Bluebeam potrzebuje więcej informacji przed zatwierdzeniem wniosku o aplikację i przekazaniem jej do produkcji

  • SANDBOX — żądanie dotyczące aplikacji zostało odrzucone lub zgłoszenie zostało wycofane

• Po ostatecznym zatwierdzeniu aplikacja jest promowana do środowiska produkcyjnego.