Erste Schritte im Bluebeam Developer Portal

Wenn Sie sich mit Ihren BBID-Anmeldeinformationen über Okta anmelden, überprüft das Portal sofort Ihre Berechtigung. Es ist keine manuelle Onboarding-Anfrage oder E-Mail an das Partnerschaftsteam erforderlich, es sei denn, Sie sind ein Softwareentwickler und/oder Partner.

Abo-Anforderungen

Bei der Anmeldung überprüft das Portal, ob Ihr Konto alle drei Kriterien erfüllt:

• Gültiges BBID-Konto

• Aktives Core-, Complete- oder Max -Abo

  • Basics-Abo nicht berechtigt: Basics-Abonnenten können nicht auf das Developer Portal zugreifen, da sie keine Projekte und Sitzungen erstellen können, die für die meisten Integrationen kritische Vorgänge sind. Upgraden Sie auf Core, Complete oder Max, um Zugriff zu erhalten.

  • Softwareentwickler und Partner: Wenn Sie eine spezielle NFR-Lizenz über Bluebeam Partnerships benötigen, müssen Sie den Zugriff auf das Bluebeam Developer Portal anfordern.

• Zulässige Region: US, AU, DE, UK und SE

Alle neuen Apps werden standardmäßig in der Sandbox-Umgebung erstellt. Sandbox bietet Ihnen einen dedizierten Bereich, um Ihre Integration sicher zu bauen und zu testen, bevor sie Endnutzer erreicht.

• Sandbox-Anmeldeinformationen bleiben konsistent, wenn Ihre App in die Produktionsumgebung verschoben wird.

• Bei der Bereitstellung für die Produktion werden die Ratenbegrenzungen angepasst, um reale Nutzungsbeschränkungen mit Support zu versehen.

• Apps bleiben in der Sandbox, bis Sie explizit eine Produktionsfreigabe anfordern (siehe Schritt 6).

Der Workflow zur App-Erstellung wurde neu gestaltet. Das Formular „Anwendung erstellen“ zeigt nur die für Bluebeam-Integrationen relevanten Felder an.

Plattform und Regionen

1. Gehen Sie zu Meine Apps und wählen Sie Anwendung erstellen.

2. Wählen Sie die API-Instanz aus, die Ihrer Region entspricht, wenn Sie Ihre Anwendung erstellen:
   

   • US: 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.s

   
   

Registrierungsformularfelder

3. Füllen Sie die Registrierungs-Formularfelder aus:

   • Anwendungsname: Darf höchstens 90 Zeichen umfassen.

   • Beschreibung: Geben Sie bis zu 300 Zeichen ein.

   • Region: Bluebeam API-Instanz für Ihre Region auswählen.

   • Weiterleitungs-URL(s): Geben Sie kommagetrennte Werte ein oder drücken Sie die Eingabetaste – das Portal organisiert sie in einer paginierten Liste.

   • Mit Postman testen? Umleitungs-URI: Verwenden Sie https://oauth.pstmn.io/v1/callback. Ihre Produktions-App wird eine andere URI verwenden.

Authentifizierungsnotizen

4. Die Bluebeam-API bietet nur Support für die folgenden Auswahlen für Grant Type:

   • Autorisierungscode: Alle API-Aufrufe verwenden OAuth 2.0; Nutzer gewähren Ihrer App Berechtigungen, in ihrem Namen zu handeln

   • Aktualisierungstoken

5. Umleitungs-URI: Verwenden Sie https://oauth.pstmn.io/v1/callback
   Diese URI ist speziell für Aufrufe in Postman bestimmt. Andere API-Werkzeuge oder Ihre App benötigen eine andere URI.

6. Wählen Sie Anwendung erstellen aus, um das Formular abzusenden.
   Nach dem Absenden des Formulars erhalten Sie eine E-Mail von MuleSoft mit dem Betreff: „Anwendungsregistrierung genehmigt.“ Bitte ignorieren Sie die E-Mail. Es ist ein unerwünschter Nebeneffekt bei der Nutzung unserer Standardlösung.

7. Anmeldedaten abrufen. Jetzt sollten Sie Ihre neu erstellte App in der Liste sehen (wenn Sie sie nicht sehen, aktualisieren Sie Ihren Browser). Klicken Sie an eine beliebige Stelle auf der App-Linie, und es erfolgt das Öffnen der Detailseite, wo Sie Ihre Client-ID und Ihr Client-Geheimnis einsehen können.
   
   

8. Verwenden Sie zum Testen Postman, um ein Zugriffstoken über Postman abzurufen.

   1. Greifen Sie über die Desktop-App oder den Browser auf Postman zu und erstellen Sie ein kostenloses Konto.

   2. Das Skript können Sie in Postman importieren . Das Skript ist eine Sammlung aller verfügbaren Bluebeam-API-Aufrufe. Gehen Sie in Postman zu Datei > Importieren und fügen Sie das Skript ein.

   3. Um einen access_token in Postman zu erhalten, wählen Sie die Sammlung Bluebeam API (Script xxx) aus.

   4. Wählen Sie die Registerkarte Autorisierung aus, um in Postman ein neues Token zu konfigurieren.
      

      Weitere Informationen zur Authentifizierung finden Sie im Authentifizierungsleitfaden. Im Authentifizierungsleitfaden stehen Anfrageparameter; diese werden in Postman als „Variablen“ bezeichnet.
      Sie können entweder eine Umgebung in Postman einrichten, um Variablen für Ihre Autorisierung zu erstellen, oder die erforderlichen Werte manuell ausfüllen.

      Erforderliche Einstellungen und Werte in Postman:

      • Authentifizierungstyp: Muss OAuth 2.0 sein

      • Berechtigungstyp: Autorisierungscode

      • Token-Name: Code

      • Berechtigungstyp: Autorisierungscode

      • Die Autorisierung über den Browser muss aktiviert sein.

      • Authentifizierungs-URL: https://api.bluebeam.com/oauth2/authorize

      • Zugriffstoken-URL: https://api.bluebeam.com/oauth2/token

      • Client-ID: Die während des App-Registrierungsprozesses erhaltene Client-ID

      • Client-Geheimnis: Das Client-Geheimnis, das Sie während des App-Registrierungsprozesses erhalten haben.

      • Umfang: Umfang für Studio-Endpunkte; die Mindestanforderung ist „offline_access“

      • Status: Status

      • Clientauthentifizierung: Client-Anmeldeinformationen im Nachrichtentext senden

   5. Scrollen Sie nach unten und auswählen Sie Neues Zugriffstoken abrufen.
   6. Anmelden mit Ihrer BBID und „Zugriff erlauben“ auswählen, wenn Sie dazu aufgefordert werden. Sie erhalten ein Token, das Sie in Postman, unserer API-Dokumentation oder Ihrem eigenen Code verwenden können.

Die Tabelle „Meine Apps“ wurde um zusätzliche Spalten erweitert, damit Sie wichtige App-Details auf einen Blick sehen können.

• Name: Ihr erstellter App-Name

• Client-ID: Der eindeutige Bezeichner, der in allen API-Anfragen verwendet wird

• Umgebung: Der aktuelle Status (Sandbox, Ausstehend oder Produktion)

• Erstellungsdatum: Das Datum, an dem die App erstellt wurde.

• Region: Die API-Region, in der das Erstellen Ihrer App erfolgte.

• Aktionen: Zum Auswählen, Bearbeiten, Löschen, Anzeigen von Anmeldeinformationen oder Anfordern der Produktionsfreigabe.

Unten in der Tabelle zeigen Sie die vorherige und nächste Seite an, wenn Sie mehrere Apps verwalten.

Suche-Endpunkte

Eine neue Stichwortsuchleiste ermöglicht Ihnen die Suche in allen Endpunkten und Parametern, ohne durch die gesamte Referenz zu scrollen. Geben Sie ein Schlüsselwort (z. B. Sitzungen, Markierungen) ein, um direkt zum relevanten Endpunkt zu gelangen.

Testanfrage

Jeder API-Endpunkt enthält jetzt eine Schaltfläche für Testanfragen. Wählen Sie es aus, um ein In-Browser-Seitenleiste zu Öffnen, wo Sie können:

• Füllen von Abfrageparametern und Anfragetexten

• Führen Sie Live-API-Aufrufe direkt aus den Docs aus

• Ansicht der vollständigen Antwort inline

• Zwischen Kodierungssprachen wechseln (Python, cURL und Ähnlichem)

Jetzt verfügbar: Markierungen-API-Endpunkte sind aus der Beta-Phase und für alle Entwickler verfügbar. Es ist kein zusätzlicher Zugriff erforderlich.

Sobald Ihre App in Sandbox gebaut und getestet wurde, wählen Sie **Produktionsfreigabe anfordern** auf der Detailseite Ihrer App in My Apps. Dadurch erfolgt das Öffnen einer voradressierten E-Mail an integrations@bluebeam.com in Ihrem Standard-E-Mail-Client.

Sie müssen folgende Informationen in der E-Mail angeben:

App-Status nach der Einreichung

• Der App-Status ändert sich in „Ausstehend“, sobald die Genehmigungsanfrage übermittelt wird.

• Nach endgültiger Genehmigung wird Ihre App in die Produktion überführt.

• Sie erhalten eine E-Mail, dass Ihre Integrations-App genehmigt wurde, und der Status im Portal ändert sich zu „Produktiv“.