Kom i gang i Bluebeam-utviklerportalen

Bluebeam API er RESTful og har for øyeblikket to kategorier av endepunkter:

• Bekreftelse

• Studio

Det finnes regionspesifikke basis-URL-er som gjelder for alle endepunkter:

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

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

– Australia: https://api.bluebeamstudio.com.au

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

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

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

Bekreftelse

Noen overordnede merknader om hvordan vi håndterer autentisering:

• Autentisering med OAuth 2.0

  • Alle API-kall gjøres i brukerkonteksten. Ved å autentisere med OAuth gir en bruker appen din tillatelse til å få tilgang til dataene sine og sende API-forespørsler på deres vegne.

• Alle forespørsler og svartekster må være JSON-formaterte. Angi Content-Type: application/json-headeren på alle forespørsler som har brødtekst.

• API-kall må gjøres via HTTPS.

• Se autentiseringsveiledningen vår for å begynne å konfigurere OAuth 2.0 i appen din.

Studio

Studio er vår skybaserte samarbeidsplattform med direkte tilkobling til vårt flaggskip-skrivebordsprogram: Bluebeam Revu. Våre Studio-endepunkter åpner opp kommunikasjonslinjer for sømløs integrasjon mellom Studio og systemene dine.

Du kan generelt tenke på funksjonaliteten som tilbys av Studio API som det samme settet med funksjonalitet som en bruker ville fått via Studio GUI i Revu.

For å lære mer om Studio, besøk vår Studio FAQ-side.

Denne prosedyren bruker Postman som et eksempel, men andre API-programmer kan brukes til å fullføre denne prosedyren.

For å få et tilgangstoken, følg disse trinnene:

1. Opprett en Bluebeam-konto og be om tilgang til Bluebeam Developer Portal, hvis du ikke allerede har gjort det.

2. Gå til developers.bluebeam.com og logg inn.

3. Be om tilgang og opprett en klient-ID.

   1. Gå til Mine apper og klikk på Be om tilgang.

   2. Fyll ut skjemaet Be om tilgang (se skjermbilde nedenfor). Velg Bluebeam API-økten som er knyttet til din spesifikke region.

      Bluebeam Developer API er den amerikanske serveren.
      
      
   Bluebeam API støtter bare følgende valg for tilskuddstype:
   • Autoriseringskode
   • Oppdater token

   3. Omdiriger URI: bruk https://oauth.pstmn.io/v1/callback

      Denne URI-en er spesifikk for å foreta anrop i Postman. Alternative API-verktøy eller appen din vil kreve en annen URI.

   4. Velg Be om å sende inn skjemaet.
      

   Godkjennings-e-post
   Når du velger Forespørsel, vil du motta en MuleSoft-e-post med emnet: «Søknadsregistrering godkjent» – vennligst ignorer denne. Det er enda en uønsket bivirkning av å bruke vår ferdige løsning.
   

4. Få legitimasjon. Nå skal du se den nylig registrerte appen din i listen (hvis du ikke ser den, oppdater nettleseren din). Hold musepekeren over nøkkelen for å få legitimasjonen din.

   
   

5. Få en tilgangstoken via Postman.

   1. Få tilgang til Postman via skrivebordsappen eller nettleseren deres og opprett en gratis konto.

   2. Her er et skript du kan importere inn i Postman. Dette skriptet er en samling av alle tilgjengelige Bluebeam API-kall. I Postman, gå til File > Import, og slipp skriptet.

   3. For å hente en access_token i Postman, velg Bluebeam API (Script xxx) -samlingen.

   4. Velg fanen Autorisasjon for å konfigurere et nytt token i Postman.

      Hvis du vil ha mer informasjon om autentisering, kan du se autentiseringsveiledningen. Autentiseringsveiledningen refererer til forespørselsparametere. Disse er kjent som variabler i Postman.
      Du kan enten sette opp et miljø i Postman for å opprette variabler for autorisasjonen din, eller du kan fylle ut manuelt nødvendige verdier.

      Nødvendige innstillinger og verdier i Postman:

      • Autorisasjonstype: Må være OAuth 2.0

      • Godkjenningstype: Autorisasjonskode

      • Tokennavn: kode

      • Tilskuddstype: Autorisasjonskode

      • Autorisasjon ved bruk av nettleser må være aktivert.

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

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

      • Klient-ID: Klient-ID mottatt under appregistreringsprosessen

      • Klienthemmelighet: Klienthemmelighet mottatt under appregistreringsprosessen

      • Omfang: Omfang for Studio-endepunkter. Minimumskravet er offline_access

      • Tilstand: Tilstand

      • Klientautentisering: Send klientlegitimasjon i brødteksten

   5. Rull ned til bunnen og klikk Få nytt tilgangstoken.
      

   6. Logg inn med BBID-en din og klikk på Tillat tilgang når du blir bedt om det. Du vil bli presentert for et token som du kan bruke i Postman, API-dokumentasjonen vår eller din egen kode.

Her er en trinnvis prosess for å migrere en eksisterende integrasjon til vår nye plattform.

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

2. Gå til developers.bluebeam.com og logg inn.

3. Registrer en ny app.

   1. Gå til Mine apper og velg Be om tilgang.

   2. Fyll ut skjemaet for forespørsel om tilgang (se skjermbilde nedenfor). Velg Bluebeam API-forekomsten som er knyttet til din spesifikke region.
      

      Merknad for tilskuddstype:

      Merk kun av i boksene ved siden av:

      • Autoriseringskode
      • Oppdater token

   3. Velg Be om å sende inn skjemaet.
      

4. Få legitimasjon. Nå skal du se den nylig registrerte appen din i listen. Hold musepekeren over nøkkelen for å få legitimasjonen din.

   
   

5. Oppdater den eksisterende integrasjonen din med de nye API-rutene for autorisasjon og Studio-endepunkter som er oppført nedenfor.
   

   Amerikanske servere
   Miljø	Opprinnelig basisrute	Ny basisrute
   Aut. – Produksjon (USA)	https://authserver.bluebeam.com/auth/oauth/authorize	https://api.bluebeam.com/oauth2/authorize
   Aut. – Produksjon (USA)	https://authserver.bluebeam.com/auth/token	https://api.bluebeam.com/oauth2/token
   Studio – Produksjon (USA)	https://studioapi.bluebeam.com:443/publicapi/v1	https://api.bluebeam.com/publicapi/v1

6. Overalt hvor du har konfigurert din eldre klient-ID og klienthemmelighet i integrasjonen din, erstatter du dem med din nye klient-ID og klienthemmelighet.

7. I API-kallene dine legger du til en header kalt « client_id» med verdien til den nye klient-ID-en din. Dette er påkrevd for alle forespørsler som kommer inn på den nye plattformen.

   Merknad
   Vi jobber fortsatt med å gjøre feilmeldingene våre mer nøyaktige og meningsfulle, men i mellomtiden, hvis du sender forespørselen din uten "client_id" -overskriften, vil du se en feilmelding som denne:
   

   copy

   {
       "msg": "Internal Server Error"
   }

8. Den nye plattformen vår håndterer autentisering litt annerledes enn den gamle plattformen vår, så vi anbefaler at du gjennomgår den nye autentiseringsveiledningen vår. To bemerkelsesverdige endringer:

   • Vi har introdusert et offline_access -omfang for oppdateringstokener (se trinn 1 i autentiseringsveiledningen ).

   • Våre svar på token-sluttpunkter har endret seg (se autentiseringsveiledningen for eksempelsvar).

9. Hvis alt er riktig konfigurert, bør du motta et svar som er identisk med det forrige Studio API-svaret for alle Studio-endepunkter.
   Hvis du for eksempel ba om en liste over Studio-prosjekter, ville svarteksten din se omtrent slik ut:
   

   copy

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

10. Test appen din og gi oss beskjed hvis du støter på noen problemer.