Aan de slag in de Bluebeam Developer Portal

Wanneer u via Okta inlogt met uw BBID-inloggegevens, verifieert de portal uw geschiktheid onmiddellijk. Er is geen handmatig onboardingverzoek of e-mail naar het Partnerschapsteam vereist, tenzij u een softwareontwikkelaar en/of partner bent.

Abonnementsvereisten

Bij het inloggen controleert het portaal of uw account aan alle drie de criteria voldoet:

• Geldig BBID-account

• Actief Core-, Complete- of Max -abonnement

  • Basics-abonnement niet geschikt: Basics-abonnees hebben geen toegang tot het Developer Portal omdat ze geen Projecten en Sessies kunnen maken, wat cruciale handelingen zijn voor de meeste integraties. Upgrade naar Core, Complete of Max om toegang te krijgen.

  • Softwareontwikkelaars en partners: Als u een speciale NFR-licentie nodig heeft via Bluebeam Partnerships, moet u toegang aanvragen tot de Bluebeam Developer Portal.

• In aanmerking komende regio: US, AU, DE, UK en SE

Alle nieuwe apps worden standaard aangemaakt in de Sandbox-omgeving. Sandbox geeft u een speciale ruimte om uw integratie veilig te bouwen en te testen voordat deze eindgebruikers bereikt.

• Sandbox-referenties blijven consistent wanneer uw app naar Productie wordt verplaatst.

• Wanneer er naar productie wordt gepromoveerd, worden snelheidslimieten aangepast voor ondersteuning van realistische gebruiksbeperkingen.

• Apps blijven in Sandbox totdat u expliciet goedkeuring voor Productie aanvraagt (zie Stap 6).

Het aanmaakproces van de app is opnieuw ontworpen. Het formulier 'Applicatie maken' toont alleen de velden die relevant zijn voor Bluebeam-integraties.

Platform en regio's

1. Ga naar Mijn apps en selecteer Toepassing maken.

2. Selecteer de API-instantie die overeenkomt met uw regio bij het maken van uw toepassing:
   

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

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

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

   • VK: https://api.bluebeamstudio.co.uk

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

   
   

Registratieformuliervelden

3. Opvullen van de velden van het Registratieformulier:

   • Applicatienaam: Voer maximaal 90 tekens in.

   • Beschrijving: Voer maximaal 300 tekens in.

   • Regio: Selecteer de Bluebeam API-instantie voor uw regio.

   • Omleidings-URL('s): Voer door komma's gescheiden waarden in of druk op Enter – het portaal organiseert ze in een gepagineerde lijst.

   • Testen met Postman? Gebruik voor de omleidings-URI https://oauth.pstmn.io/v1/callback. Je productie-app gebruikt een andere URI.

Authenticatieopmerkingen

4. Bluebeam API ondersteunt alleen de volgende selecties voor Grant Type:

   • Autorisatiecode: Alle API-aanroepen gebruiken OAuth 2.0; gebruikers verlenen uw app toestemming om namens hen te handelen.

   • Token vernieuwen

5. Omleidings-URI: Gebruik https://oauth.pstmn.io/v1/callback
   Deze URI is specifiek voor het maken van oproepen in Postman. Andere API-tools of je app vereisen een andere URI.

6. Selecteer Applicatie maken om het formulier in te dienen.
   Na het indienen van het formulier ontvangt u een MuleSoft-e-mail met als onderwerp: "Aanvraag registratie goedgekeurd". Gelieve de e-mail te negeren. Het is een ongewenst neveneffect van het gebruik van onze kant-en-klare oplossing.

7. Gegevens verkrijgen. Nu ziet u uw nieuw gemaakte app in de lijst (als u deze niet ziet, vernieuw dan uw browser). Klik ergens op de app-lijn en de detailpagina wordt geopend waar u uw Client-id en Clientgeheim kunt bekijken.
   
   

8. Als u Postman gebruikt voor testen, haal dan een toegangstoken op via Postman.

   1. U kunt Postman openen via de desktop-app of browser en een gratis account maken.

   2. Hier is een script dat je in Postman kunt importeren. Dit script is een verzameling van alle beschikbare Bluebeam API-aanroepen. Ga in Postman naar Bestand > Importeren en zet het script daar neer.

   3. Om een access_token in Postman te verkrijgen, Selecteren de Bluebeam API (Scripts xxx) -verzameling.

   4. Selecteer het tabblad Autorisatie om een nieuw token te configureren in Postman.
      

      Voor meer informatie over authenticatie, zie de Authenticatiegids. De Authenticatiegids verwijst naar verzoekparameters; deze staan bekend als variabelen in Postman.
      Je kunt ofwel een omgeving in Postman instellen om variabelen voor je autorisatie te maken, of je kunt handmatig de vereiste waarden invullen.

      Vereiste instellingen en waarden in Postman:

      • Authenticatietype: Moet OAuth 2.0 zijn.

      • Grant Type: Authorization Code

      • Tokennaam: code

      • Toekenningscode: Authorisatiecode

      • Autoriseren via de browser moet ingeschakeld zijn.

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

      • URL voor toegangstoken: https://api.bluebeam.com/oauth2/token

      • Client-id: Client-id die is ontvangen tijdens het registratieproces van de app

      • Client Secret: Client Secret ontvangen tijdens het app-registratieproces

      • Scope: Scopes voor Studio-eindpunten; het minimum vereiste is offline_access

      • Status: Status

      • Clientverificatie: verzend klantgegevens in de hoofdtekst

   5. Scrol naar beneden en selecteer Nieuwe toegangstoken ophalen.
   6. Meld u aan met uw BBID en selecteer Toegang toestaan wanneer daarom wordt gevraagd. U krijgt een token dat u kunt gebruiken in Postman, onze API-documentatie of uw eigen code.

De tabel Mijn apps is bijgewerkt met aanvullende kolommen, zodat u belangrijke app-details in één oogopslag kunt zien.

• Naam: Uw maken appnaam

• Client-id: De unieke identificatie die wordt gebruikt in alle API-aanvragen

• Omgeving: De huidige status (Sandbox, In behandeling of Productie)

• Aanmaakdatum: de datum waarop de app is aangemaakt

• Regio: De API-regio waarin uw app dient te Maken

• Acties: Selecteer bewerken, verwijderen, referenties bekijken of productiegoedkeuring aanvragen.

Onderaan de tabel kunt u de vorige en volgende pagina's bekijken als u meerdere apps beheert.

Eindpunten zoeken

Met een nieuwe zoekbalk voor trefwoorden kunt u zoeken in alle eindpunten en parameters zonder door de volledige referentie te scrollen. Typ een trefwoord (bijv. sessies, markeringen) om naar het relevante eindpunt te gaan.

Testaanvraag

Elk API-eindpunt bevat nu een knop voor testverzoek. Selecteer deze om een in-browserpaneel te openen waar u kunt:

• Opvullen queryparameters en aanvraagteksten

• Voer live API-aanroepen rechtstreeks vanuit de documentatie uit.

• Weergave van de volledige reactie inline.

• Wissel tussen programmeertalen (Python, cURL en meer)

Nu beschikbaar: Markeringen API-eindpunten zijn uit Bèta en beschikbaar voor alle ontwikkelaars. Er is geen extra toegang vereist.

Zodra uw app is gebouwd en getest in Sandbox, selecteert u **Productiegoedkeuring aanvragen** op de detailpagina van uw app in My Apps. Hiermee wordt een vooraf geadresseerde e-mail naar integrations@bluebeam.com geopend in uw standaard e-mailclient.

U moet de volgende informatie in de e-mail opnemen:

Appstatus na inzending

• App-status wijzigt naar in afwachting zodra de goedkeuringsaanvraag is ingediend.

• Na definitieve goedkeuring wordt uw app gepromoveerd naar Productie.

• U ontvangt een e-mail dat uw integratie-app is goedgekeurd en de status zal in de portal naar Productie veranderen.