Komma igång i Bluebeams Developer Portal

Bluebeams API är RESTful och har för närvarande två kategorier av slutpunkter:

• Autentisering

• Studio

Autentisering

Några anteckningar på hög nivå om hur vi hanterar autentisering:

• Autentisering med AAuth 2.0

  • Alla API-anrop görs i en användares kontext. Genom att autentisera sig med oauth ger en användare din App behörighet att komma åt sina data och göra API-begäranden för sin räkning.

• Alla förfrågningar och svars brödtext måste vara JSON-formaterad. Ställ in rubriken Content-Type: application/json på alla begäranden som har brödtext.

• API-anrop måste göras över HTTPS.

• Se vår autentiseringsguide för information om hur du kommer igång med att konfigurera AAuth 2.0 i din app.

Studio

Studio är vår plattform för molnsamarbete med en direkt koppling till vår flaggskeppsapplikation Bluebeam Revu. Våra Studio-slutpunkter öppnar upp för kommunikationslinjer för sömlös integration mellan Studio och dina system.

Generellt kan man se till att de funktioner som erbjuds i Studio API är samma uppsättning funktioner som en användare skulle få genom det grafiska Studio-gränssnittet i Revu.

Om du vill veta mer om Studio kan du gå till vår sida med vanliga frågor om Studio.

För att snabba på processen rekommenderar vi att du använder en app som heter Postman. Gör så här:

1. Skapa ett BBID-konto om du inte redan har gjort det.

2. Gå till developers.bluebeam.com och logga in.

3. Registrera dig för åtkomst.

   1. Gå till Mina appar och klicka på Begär åtkomst.

   2. Fyll i formuläret Begär åtkomst.

   Anmärkning om bidragstyp:
   Markeraendast rutorna intill:
   • Auktoriseringskod
   • Uppdatera token

   3. Omdirigerings-URI: använd https://oauth.pstmn.io/v1/callback

   4. Välj Begäran om att skicka formuläret.
      

   E-postmeddelande för godkännande
   När du har valt Begär får du ett e-postmeddelande från MuleSoft med ämnet: Registrering av ansökan godkänd – ignorera. Det är en annan oönskad bieffekt av att använda vår färdiga lösning.
   

4. Hämta inloggningsuppgifter. Nu bör du se din nyregistrerade App i listan (uppdatera din webbläsare om du inte ser den). Håll muspekaren över tangenten för att hämta dina inloggningsuppgifter.

   
   

5. Få en åtkomsttoken via Postman.

   1. Kom åt Postman via skrivbordsappen eller webbläsaren och skapa ett kostnadsfritt konto.

   2. Här är ett skript som du kan importera till Postman. I Postman går du till Arkiv > Importera och släpper skriptet.

   3. För att få en access_token i Postman väljer du samlingen Bluebeam API (Script xxx).

   4. Gå till fliken Auktorisering och ersätt de orangefärgade variablerna {{client_id}} och {{client_secret}} med det klient-ID och den klienthemlighet som du fick i Mina appar.

   5. Bläddra längst ner och klicka på Hämta ny åtkomsttoken.
      
      

   6. Logga in med ditt BBID och klicka på Tillåt åtkomst när du blir ombedd att göra det. Du får en token som du kan använda i Postman, våra API-dokument eller din egen kod.

Här är en steg-för-steg-process för att migrera en befintlig integration till vår nya plattform.

1. Skapa ett BBID-konto om du inte redan har gjort det.

2. Gå till developers.bluebeam.com och logga in.

3. Registrera en ny app.

   1. Gå till Mina appar och välj Begär åtkomst.

   2. Fyll i formuläret Begär åtkomst.

      Anmärkning om bidragstyp:

      Markeraendast rutorna intill:

      • Auktoriseringskod
      • Uppdatera token

   3. Välj Begäran om att skicka formuläret.
      

4. Hämta inloggningsuppgifter. Nu bör du se din nyregistrerade App i listan. Håll muspekaren över tangenten för att hämta dina inloggningsuppgifter.

   
   

5. Uppdatera din befintliga integration med de nya API-rutter för auktorisering och Studio-slutpunkter som anges nedan.
   

   USA-servrar
   Miljö	Ursprunglig basrutt	Ny basrutt
   Autentisering – produktion (USA)	https://authserver.bluebeam.com/auth/oauth/authorize	https://api.bluebeam.com/oauth2/authorize
   Autentisering – produktion (USA)	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. Överallt där du har ditt äldre klient-ID och klienthemlighet konfigurerat i integrationen kan du ersätta dem med ditt nya klient-ID och klienthemlighet.

7. I dina API-anrop lägger du till en rubrik som heter "client_id" med värdet för ditt nya klient-ID. Det här krävs för alla förfrågningar som skickas till den nya plattformen.

   Anteckning
   Vi arbetar fortfarande på att göra vårt felmeddelande mer exakt och meningsfullt, men om du under tiden skickar din förfrågan utan rubriken "client_id" ser du ett sådant felmeddelande:
   

   copy

   1
   2
   3
   {
       "msg": "Internt serverfel"
   }

8. Vår nya plattform hanterar autentisering lite annorlunda än vår gamla, så vi rekommenderar att du läser vår nya autentiseringsguide. Två viktiga ändringar:

   • Vi har infört ett område för offlineåtkomst för uppdateringstokens (se steg 1 i autentiseringsguiden ).

   • Våra tokenslutpunkterssvar har ändrats (se exempelsvar i Autentiseringsguiden).

9. Om allt är rätt konfigurerat bör du få ett svar som är identiskt med det tidigare Studio API:et för alla Studio-slutpunkter.
   Om du till exempel begär en lista över Studio-projekt ser svarsbrödtexten ut ungefär så här:
   

   copy

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
   {
     "$id": "1"
     "Projects": [
       {
         "$id": "2",
         "Id": "385-509-537",
         "Guid": "Msu1D6xhLE2bE0y2F4ozfQ",
         "Name": "Test Project Name",
         "Restricted": true,
         "Created": "2024-02-29T17:40:58.043",
         "OwnerNameIdentifier": "e149e277-3052-4f3e-a376-29fc6c5aa76c",
         ": "OwjenerEmail" @bluebeam.com"
       }
     ]
   }

10. Du gjorde det! Testa din app och berätta för oss om du stöter på problem.