Pierwsze kroki w Bluebeam Developer Portal

Bluebeam Developer Portal, przeznaczony do tworzenia integracji, jest dostępny tylko dla aktywnych klientów, partnerów kanałowych i partnerów oprogramowania w regionach USA, Australii, Niemiec, Wielkiej Brytanii i Szwecji.

Ta strona jest Twoim przewodnikiem po naszym nowym Developer Portal. Zalecamy Otwórz go w osobnej karta, przechodząc przez kolejne kroki w oddzielnej karta.

Aby rozpocząć, utwórz konto Bluebeam i poproś o dostęp do Bluebeam Developer Portal, jeśli jeszcze tego nie zrobiłeś.

Wybierz swoją ścieżkę:

Bluebeam API jest interfejsem RESTful i obecnie posiada 2 kategorie punktów końcowych:

  • Uwierzytelnianie

  • Studio

Istnieją podstawowe adresy URL specyficzne dla regionu, które mają zastosowanie do wszystkich punktów końcowych:

- PL: https://api.bluebeam.com

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

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

- UK: https://api.bluebeamstudio.co.uk

- SE: https://api.bluebeamstudio.se

Na przykład, https://api.bluebeam.com/publicapi/v1/sessions w USA byłby https://api.bluebeamstudio.com.au/publicapi/v1/sessions w Australii.

Uwierzytelnianie

Kilka ogólnych notatek o tym, jak obsługujemy uwierzytelnianie:

  • Uwierzytelnianie za pomocą OAuth 2.0

    • Wszystkie wywołania API są wykonywane w kontekście użytkownika. Uwierzytelniając się za pomocą protokołu OAuth, użytkownik udziela Twojej aplikacji uprawnień do uzyskania dostępu do swoich danych i wykonywania żądań API w jego imieniu.

  • Wszystkie żądania i treści odpowiedzi muszą być sformatowane w formacie JSON. Ustaw nagłówek Content-Type: application/json we wszystkich żądaniach, które mają treść.

  • Wywołania API muszą być wykonywane przez HTTPS.

  • Zapoznaj się z naszym przewodnikiem uwierzytelniania , aby rozpocząć konfigurację OAuth 2.0 w aplikacji.

Studio

Studio to nasza chmurowa platforma współpracy z bezpośrednim połączeniem z naszą flagową aplikacją komputerową: Bluebeam Revu. Nasze punkty końcowe Studio umożliwiają płynną komunikację, zapewniając bezproblemową integrację między Studio a Twoimi systemami.

Można ogólnie pomyśleć o funkcjonalności oferowanej przez Studio API jako o tym samym zestawie funkcjonalności, które użytkownik uzyskałby za pośrednictwem interfejsu Studio w Revu.

Aby dowiedzieć się więcej o Studio, przejdź do naszej strony Studio FAQ.

Ta procedura wykorzystuje Postman jako przykład, ale do ukończenia tej procedury można użyć innego oprogramowania API.

Aby uzyskać token dostępu, wykonaj następujące kroki:

Ta procedura wymaga danych z Przewodnika uwierzytelnienia.

  1. Utwórz konto Bluebeam i zażądaj dostępu do Bluebeam Developer Portal, jeśli jeszcze tego nie zrobiłeś.

  2. Przejdź do developers.bluebeam.com i zaloguj się.

  3. Zażądaj dostępu i utwórz identyfikator klienta.

    1. Przejdź do Moje aplikacje i kliknij Zażądaj dostępu.

    2. Wypełnij formularz Żądanie dostępu (patrz zrzut ekranu poniżej). Wybierz instancję Bluebeam API powiązaną z Twoim konkretnym regionem.

      Bluebeam Developer API to amerykański serwer.

      3. Interfejs API Bluebeam obsługuje tylko następujące opcje typu udzielenia:
      • Kod autoryzacji
      • Token odświeżania

    3. Identyfikator URI przekierowania: użyj https://oauth.pstmn.io/v1/callback

      Ten identyfikator URI jest specyficzny dla wykonywania połączeń w programie Postman. Alternatywne narzędzia API lub Twoja aplikacja będzie wymagać innego identyfikatora URI.

    4. Wybierz Żądanie, aby przesłać formularz.

      5. E-mail zatwierdzający
      Po wybraniu Żądania otrzymasz wiadomość e-mail marki MuleSoft z tematem: „Rejestracja aplikacji zatwierdzona” — proszę zignoruj. To kolejny niepożądany efekt uboczny korzystania z naszego gotowego rozwiązania.

  4. Pobierz poświadczenia. Teraz powinieneś zobaczyć swoją nowo zarejestrowaną aplikację na liście (jeśli jej nie widzisz, odśwież przeglądarkę). Najedź kursorem na klucz, aby uzyskać swoje poświadczenia.


  5. Pobierz token dostępu za pośrednictwem Postmana.

    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ć Closedwymagane 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 kliknij Pobierz nowy token dostępu.

    6. Zaloguj się przy użyciu identyfikatora BBID i kliknij Zezwól na dostęp po wyświetleniu monitu. Otrzymasz token, którego możesz użyć w Postmanie, naszej dokumentacji interfejsów API lub we własnym kodzie.

Wygaśnięcie tokenu
Tokeny wygasają po 1 godzinie, więc jeśli Twoje połączenia przestaną działać, przejdź przez proces jeszcze raz, aby uzyskać nowy token. Aby skonfigurować OAuth do używania tokenów odświeżania, zobacz nasz Przewodnik po uwierzytelnianiu .

Oto proces krok po kroku do migracji istniejącej integracji na naszą nową platformę.

  1. Utwórz konto BBID, jeśli jeszcze tego nie zrobiłeś/aś.

  2. Przejdź do developers.bluebeam.com i zaloguj się.

  3. Zarejestruj nową aplikację.

    1. Przejdź do Moje aplikacje i wybierz Zażądaj dostępu.

    2. Wypełnij formularz Żądanie dostępu (patrz zrzut ekranu poniżej). Wybierz instancję Bluebeam API skojarzoną z Twoim regionem.

      Notatka dla typu udzielenia:

      Tylko wybierz obszary obok:

      • Kod autoryzacji
      • Token odświeżania

    3. Wybierz Żądanie, aby przesłać formularz.

  4. Pobierz poświadczenia. Teraz powinna być widoczna Twoja nowo zarejestrowana aplikacja na liście. Najedź kursorem na klucz, aby uzyskać swoje poświadczenia.


  5. Zaktualizuj swoją istniejącą integrację o nowe trasy API dla punktów końcowych autoryzacji i Studio, wymienionych poniżej.

    Stany Zjednoczone Serwery

    Środowisko

    Oryginalna trasa podstawowa

    Nowa Trasa Bazowa

    Auth – Produkcja (US)

    https://authserver.bluebeam.com/auth/oauth/authorize

    https://api.bluebeam.com/oauth2/authorize

    Auth – Produkcja (US)

    https://authserver.bluebeam.com/auth/token

    https://api.bluebeam.com/oauth2/token

    Studio – Produkcja (USA)

    https://studioapi.bluebeam.com:443/publicapi/v1

    https://api.bluebeam.com/publicapi/v1

  6. Wszędzie tam, gdzie w integracji skonfigurowano dotychczasowy identyfikator klienta i klucz tajny klienta, zastąp je nowym identyfikatorem klienta i kluczem tajnym.

  7. W swoich wywołaniach API dodaj nagłówek o nazwie «client_id» z wartością nowego identyfikatora klienta. Jest to wymagane dla wszystkich żądań dotyczących nowej platformy.

    Notatka
    Nadal pracujemy nad tym, aby nasze komunikaty o błędach były dokładniejsze i bardziej zrozumiałe, ale w międzyczasie, jeśli wyślesz swoje zapytanie bez nagłówka "client_id", zobaczysz komunikat o błędzie taki jak ten:

    Kopiuj
    {
        "msg": "Internal Server Error"
    }

  8. Nasza nowa platforma obsługuje uwierzytelnianie nieco inaczej niż nasza stara platforma, dlatego zalecamy przejrzenie naszego nowego Przewodnika uwierzytelniania . Dwie godne uwagi zmiany:

  9. Jeśli wszystko jest poprawnie skonfigurowane, otrzymasz odpowiedź identyczną do odpowiedzi z poprzedniego interfejsu API Studio dla wszystkich punktów końcowych Studio.
    Na przykład, jeśli zażądano listy Projektów Studio, treść odpowiedzi wyglądałaby następująco:

    Kopiuj 
    {
      "$id": "1"
      "Projekty": [
        {
          "$id": "2",
          "Id": "385-509-537",
          "Guid": "Mzu5D6xhLE2bE0y2F4ozfQ",
          "Name": "Test Project Name",
          "Restricted": Prawda,
          "Created": "2024-02-29T17:40:58.043",
          "OwnerNameIdentifier": "e149e277-3052-4f3e-a376-29fc6c5aa76c",
          "OwnerEmail": "jdoe@bluebeam.com"
        }
      ]
    }

  10. Przetestuj swoją aplikację i poinformuj nas, jeśli napotkasz jakiekolwiek problemy.

 

Zobacz także:


Zasoby

Revu 21

Developer Portal

Developer Portal

Ta strona to Twój przewodnik po naszym nowym Developer Portal.