Kom i gang med at bruge Bluebeam Developer Portal

Bluebeam API er RESTful og har i øjeblikket to kategorier af slutpunkter:

• Godkendelse

• Studio

Der er områdespecifikke basis-URL-adresser, der gælder for alle slutpunkter:

- 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.se

For eksempel vil https://api.bluebeam.com/publicapi/v1/sessions i USA være https://api.bluebeamstudio.com.au/publicapi/v1/sessions i Australien.

Godkendelse

Nogle noter på højt niveau om, hvordan vi håndterer godkendelse:

• Godkendelse med OAuth 2.0

  • Alle API-kald foretages i en brugerkontekst. Ved at godkende med OAuth giver en bruger din app tilladelse til at få adgang til sine data og lave API-anmodninger på sine vegne.

• Alle anmodninger og svartekster skal være JSON-formateret. Indstil Content-Type: application/json-overskriften på alle anmodninger, der har brødtekst.

• API-kald skal foretages over HTTPS.

• Se vores Authentication Guide for at begynde at konfigurere OAuth 2.0 i din app.

Studio

Studio er vores samarbejdsplatform i skyen med direkte forbindelse til vores flagskibsapplikation til computere: Bluebeam Revu. Vores Studio-slutpunkter åbner op for kommunikationslinjer for problemfri integration mellem Studio og dine systemer.

Du kan generelt betragte de funktioner, der tilbydes af Studio API, som det samme sæt funktionalitet, som en bruger ville få via Studio GUI i Revu.

Du kan få mere at vide om Studio på vores side med ofte stillede spørgsmål om Studio.

Denne procedure bruger Postman som eksempel, men andre API-softwareprogrammer kan bruges til at fuldføre denne procedure.

Følg disse trin for at få en adgangstoken:

1. Opret en Bluebeam-konto og anmod om adgang til Bluebeam Developer Portal, hvis du ikke allerede har gjort det.

2. Gå til developers.bluebeam.com, og log ind.

3. Anmod om adgang og opret et klient-ID.

   1. Gå til Mine apps, og klik på Anmod om adgang.

   2. Udfyld formularen Anmod om adgang (se skærmbillede nedenfor). Vælg den Bluebeam API-version, der er knyttet til din specifikke region.

      Bluebeam Developer API er den amerikanske server.
      
      
   Bluebeam API understøtter kun følgende valg for bevillingstype:
   • Autorisationskode
   • Opdateringstoken

   3. 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.

   4. Vælg Anmodning for at indsende formularen.
      

   Godkendelsesmail
   Når du har valgt Anmodning, modtager du en e-mail fra MuleSoft med emnet: "Ansøgningsregistrering godkendt" – ignorer venligst. Det er en anden uønsket bivirkning ved at bruge vores færdige løsning.
   

4. Få legitimationsoplysninger. Nu bør du se din nyligt registrerede App på listen (hvis du ikke kan se den, skal du opdatere din browser). Hold markøren over tasten for at få dine legitimationsoplysninger.

   
   

5. Få 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 ned til bunden, og klik på Hent ny adgangstoken.
      

   6. Log på med dit BBID, og klik på Tillad adgang, når du bliver bedt om det. Du vil blive præsenteret for et token, som du kan bruge i Postman, vores API-dokumenter eller din egen kode.

Her er en trinvis proces til at migrere en eksisterende integration til vores nye platform.

1. Opret en BBID-konto, hvis du ikke allerede har gjort det.

2. Gå til developers.bluebeam.com, og log ind.

3. Registrer en ny app.

   1. Gå til Mine apps, og vælg Anmod om adgang.

   2. Udfyld formularen Anmod om adgang (se skærmbillede nedenfor). Vælg den Bluebeam API -version, der er knyttet til din specifikke region.
      

      Bemærkning til tilskudstype:

      Markérkun felterne ved siden af:

      • Autorisationskode
      • Opdater token

   3. Vælg Anmodning for at indsende formularen.
      

4. Få legitimationsoplysninger. Nu bør du se din nyligt registrerede App på listen. Hold markøren over tasten for at få dine legitimationsoplysninger.

   
   

5. Opdater din eksisterende integration med de nye API-ruter til godkendelse og Studio-slutpunkter, der er anført nedenfor.
   

   Servere i USA
   Miljø	Oprindelig basisrute	Ny basisrute
   Auth – Production (US)	https://authserver.bluebeam.com/auth/oauth/authorize	https://api.bluebeam.com/oauth2/authorize
   Auth – Production (US)	https://authserver.bluebeam.com/auth/token	https://api.bluebeam.com/oauth2/token
   Studio – Produktion (USA)	https://studioapi.bluebeam.com:443/publicapi/v1	https://api.bluebeam.com/publicapi/v1

6. Alle steder, hvor du har konfigureret dit tidligere klient-ID og din klienthemmelighed i din integration, skal du erstatte dem med dit nye klient-ID og din nye hemmelighed.

7. I dine API-kald skal du tilføje en overskrift kaldet "client_id" med værdien af dit nye Client ID. Dette er påkrævet for alle forespørgsler, der rammer den nye platform.

   Bemærkning
   Vi arbejder stadig på at gøre vores fejlmeddelelser mere præcise og meningsfulde, men i mellemtiden, hvis du sender din forespørgsel uden "client_id"-headeren, får du vist en fejlmeddelelse som denne:
   

   copy

   {
       "msg": "Internal Server Error"
   }

8. Vores nye platform håndterer godkendelse lidt anderledes end vores gamle platform, så vi anbefaler at gennemgå vores nye godkendelsesguide. To bemærkelsesværdige ændringer:

   • Vi har introduceret et område for offlineadgang til opdateringstokener (se trin 1 i godkendelsesvejledningen).

   • Vores token-slutpunktssvar er ændret (se eksempler på svar i Authentication Guide).

9. Hvis alt er konfigureret korrekt, bør du modtage et svar, der er identisk med det tidligere Studio API's svar for alle Studio-slutpunkter.
   Hvis du for eksempel anmodede om en liste over Studio-projekter, ville dit svar se nogenlunde således ud:
   

   copy

   {
     "$id": "1"
     "Projects": [
       {
         "$id": "2",
         "Id": "385-509-537",
         "Guid": "Mzu1D6xhLE2bE0y2F4ozfQ",
         "Name": "Testprojektnavn",
         "Restricted": true,
         "Created": "2024-02-29T17:40:58.043",
         "OwnerNameIdentifier": "e149e277-3052-4f3e-a376-29fc6c5aa76c",
         "OwnerEmail": "jdoe@bluebeam.com"
       }
     ]
   }

10. Test din app, og fortæl os, hvis du støder på problemer.