Kom i gang med at bruge Bluebeam Developer Portal

Når du logger ind med dine BBID-legitimationsoplysninger via Okta, bekræfter portalen øjeblikkeligt din berettigelse. Der kræves ingen manuel onboarding-anmodning eller e-mail til partnerteamet, medmindre du er softwareudvikler og/eller partner.

Abonnementskrav

Ved login kontrollerer portalen, at din konto opfylder alle tre kriterier:

• Gyldig BBID-konto

• Aktivt Core-, Complete- eller Max -abonnement

  • Basics-abonnement er ikke berettiget: Basics-abonnenter kan ikke få adgang til Developer Portal, fordi de ikke kan oprette projekter og sessioner, hvilket er afgørende handlinger for de fleste integrationer. Opgrader til Core, Complete eller Max for at få adgang.

  • Softwareudviklere og partnere: Hvis du har brug for en speciel NFR-licens gennem Bluebeam Partnerships, skal du anmode om adgang til Bluebeam Developer Portal.

• Berettiget region: US, AU, DE, UK og SE

Alle nye apps oprettes som standard i Sandbox-miljøet. Sandbox giver dig et dedikeret rum til at bygge og teste din integration sikkert, før den når slutbrugere.

• Sandbox-legitimationsoplysninger forbliver ensartede, når din app flyttes til Produktion.

• Når de promoveres til Produktion, vil hastighedsgrænserne justeres for at understøtte begrænsninger i den virkelige verden.

• Apps forbliver i Sandbox, indtil du udtrykkeligt anmoder om godkendelse til Produktion (se Trin 6).

App-oprettelsesflowet er blevet redesignet. Formularen Opret applikation viser kun de felter, der er relevante for Bluebeam-integrationer.

Platform og regioner

1. Gå til My Apps, og vælg Opret applikation.

2. Vælg den API-version, der matcher din region, når du opretter din applikation:
   

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

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

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

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

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

   
   

Registreringsformularfelter

3. Udfyldning af registreringsformularens felter:

   • Programnavn: Indtast op til 90 tegn.

   • Beskrivelse: Angiv op til 300 tegn.

   • Region: Vælg den Bluebeam API-version til din region.

   • Omdirigerings-URL'er: Indtast kommaseparerede værdier, eller tryk på Enter – portalen organiserer dem på en sideinddelt liste.

   • Tester med Postman? For Omdirigerings-URI, brug https://oauth.pstmn.io/v1/callback. Din produktionsapp vil bruge en anden URI.

Godkendelsesnoter

4. Bluebeam API understøtter kun følgende valgmuligheder for Grant Type:

   • Godkendelseskode: Alle API-kald bruger OAuth 2.0; brugere giver din app tilladelse til at handle på deres vegne

   • Opdateringstoken

5. Omdirigerings-URI: Brug https://oauth.pstmn.io/v1/callback
   Denne URI er specifik til at foretage opkald i Postman. Alternative API-værktøjer eller din app kræver en anden URI.

6. Vælg Opret applikation for at indsende formularen.
   Når du har indsendt formularen, modtager du en MuleSoft-brandet e-mail med emnet: ”Applikationsregistrering godkendt“. Ignorer venligst e-mailen. Det er en uønsket bivirkning ved at bruge vores ud af boksen-løsning.

7. Hent legitimationsoplysninger. Nu burde du se din nyoprettede app på listen (hvis du ikke kan se den, skal du opdatere din browser). Klik et vilkårligt sted på app-linjen, så vil det åbn detaljesiden, hvor du kan se dit klient-id og din klienthemmelighed.
   
   

8. Hvis du bruger Postman til test, skal du hente et adgangstoken via Postman.

   1. Få adgang til Postman via deres stationære app eller browser, og opret en gratis konto.

   2. Her er et script, som du kan importere til Postman. Dette script er en samling af alle tilgængelige Bluebeam API-kald. I Postman skal du gå til File > Import og indsætte scriptet.

   3. For at få et access_token i Postman skal du vælge samlingen Bluebeam API (Script xxx).

   4. Vælg fanen Authorization for at konfigurere et nyt token i Postman.
      

      Du kan finde yderligere oplysninger om godkendelse i vejledningen til godkendelse. Vejledningen til godkendelse henviser til anmodningsparametre. Disse kaldes variabler i Postman.
      Du kan enten oprette et miljø i Postman til at oprette variabler til din autorisation, eller du kan manuelt udfylde nødvendige værdier.

      Påkrævede indstillinger og værdier i Postman:

      • Godkendelsestype: Skal være OAuth 2.0

      • Tildelingstype: godkendelseskode

      • Tokennavn: kode

      • Tildelingstype: godkendelseskode

      • Autoriser via browser skal være aktiveret.

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

      • URL til adgangstoken: https://api.bluebeam.com/oauth2/token

      • Klient-ID: Klient-ID modtaget under app-registreringsprocessen

      • Klienthemmelighed: Klienthemmelighed modtaget under app-registreringsprocessen

      • Omfang: Omfang for Studio-slutpunkter; minimumskravet er offline_access

      • Tilstand: Tilstand

      • Klientgodkendelse: Send klientlegitimationsoplysninger i brødteksten

   5. Rul til bunden, og vælg Hent nyt adgangstoken.
   6. Log på med dit BBID, og vælg Giv adgang, når du bliver bedt om det. Du får vist et token, som du kan bruge i Postman, vores API-dokumentation eller din egen kode.

Tabellen Mine apps er blevet opdateret med yderligere kolonner, så du kan se vigtige appoplysninger med et øjeblik.

• Navn: Navnet på din opret app

• Klient-ID: Den unikke identifikator, der bruges i alle API-anmodninger.

• Miljø: Aktuel status (Sandkasse, Afventer eller Produktion)

• Dato for opret: Den dato, appen blev opret

• Region: Den API-region din app Opret i

• Handlinger: Vælg at redigere, slette, se legitimationsoplysninger eller anmode om produktionsgodkendelse

Nederst i tabellen kan du se de forrige og næste sider, hvis du administrerer flere apps.

Søg efter slutpunkter

En ny Søg-linje til nøgleord lader dig søge på tværs af alle slutpunkter og parametre uden at skulle rulle gennem hele referencen. Skriv et søgeord (f.eks. sessioner, markeringer) for at springe til det relevante slutpunkt.

Testanmodning

Hvert API-slutpunkt indeholder nu en testanmodnings-knap. Vælg den for at åbne et panel i browseren, hvor du kan:

• Udfyldning af forespørgselsparametre og anmodningstekster

• Udfør live API-kald direkte fra dokumentationen

• Se hele svaret direkte

• Skift mellem kodningssprog (Python, cURL og mere)

Nu tilgængelig: Markeringer API-slutpunkter er ude af beta og tilgængelige for alle udviklere. Der kræves ingen yderligere adgang.

Når din app er bygget og testet i Sandkasse, skal du vælge Anmod om produktionsgodkendelse på din apps detaljeside under My Apps. Dette åbner en forudadresseret e-mail til integrations@bluebeam.com i din standard-e-mailklient.

Du skal inkludere følgende oplysninger i e-mailen:

Appstatus efter indsendelse

• App-status ændres til Afventer, når anmodningen om godkendelse er indsendt.

• Efter endelig godkendelse sendes din app til produktion.

• Du modtager en e-mail om, at din integrationsapp er godkendt, og statussen ændres til Produktion i portalen.