Kom igång med Bluebeam Developer Portal

Bluebeam Developer Portal har byggts om för att ge utvecklare en snabbare och tydligare självbetjäningsupplevelse. Den här guiden går igenom den nya Sandbox-miljön, det strömlinjeformade appregistreringsflödet, API-testning i webbläsaren och den nya godkännandeprocessen för produktion.

För att komma igång, granska översikten Kom igång.

Välj sökväg:

Nyheter

  • Automatiserad registrering (kommer snart): Åtkomst beviljas omedelbart vid inloggning baserat på din prenumeration.

  • Arbetsflöde med sandlådan först: Alla appar startar i sandlådan, vilket ger dig en säker plats att bygga och testa innan du går live.

  • Förenklad applikationsskapande: Det nya formuläret ”Skapa applikation” visar endast de fält som gäller för Bluebeam-integrationer.

  • API-testning i webbläsaren: Den nya ”Test Request”-funktionen låter dig utföra anrop direkt i dokumentationen, på flera språk.

  • Slutpunktssökning: Sök bland alla API-slutpunkter och parametrar utan att behöva rulla.

  • Markeringar API-slutpunkter: Dessa slutpunkter har lämnat betafasen och är tillgängliga för alla utvecklare.

Så här kommer du igång – översikt

Steg 1: Logga in
Gå till developers.bluebeam.se och logga in med ditt BBID. Åtkomst beviljas automatiskt med en aktiv prenumerationsplan av typen Core, Complete eller Max. Gå till Steg 1 ➝

Steg 2: Bygg och testa i Begränsat läge
Använd dina Sandbox-uppgifter för att bygga och testa innan din integration når slutanvändare. Gå till Steg 2 ➝

Steg 3: Skapa applikation
Gå till My Apps och välj Skapa program. Ange programnamn, beskrivning, region och omdirigerings-URI:er. Gå till steg 3 ➝

Steg 4: Visa instrumentpanelen Mina appar
Mina appar-tabellen har uppdaterats med ytterligare kolumner så att du snabbt kan få en överblick över viktiga appdetaljer. Gå till Steg 4 ➝

Steg 5: Granska API-dokumentation och testförfrågan
Använd testbegäran i API-dokumentationen för att validera slutpunktsbeteendet i webbläsaren. Gå till Steg 5 ➝

Steg 6: Begär produktionsgodkännande
Från din apps detaljsida väljer du Begär produktionsgodkännande och mejlar de nödvändiga uppgifterna till integrations@bluebeam.com. Gå till steg 6 ➝

Steg 7: Gå live
Bluebeam-integrationsteamet granskar och följer upp. När den har godkänts befordras din app till Produktion.

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

  • Autentisering

  • Studio

Det finns regionspecifika bas-URL:er som gäller för alla slutpunkter:

Till exempel blir https://api.bluebeam.com/publicapi/v1/sessions i regionen US https://api.bluebeamstudio.com.au/publicapi/v1/sessions i regionen AU.

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.

Gör så här för att hämta en åtkomsttoken:

Den här processen kräver data från autentiseringsguiden.

När du loggar in med dina BBID-inloggningsuppgifter via Okta verifierar portalen omedelbart din behörighet. Ingen manuell registreringsbegäran eller e-post till partnerskapsteamet krävs såvida du inte är en programvaruutvecklare och/eller partner.

Prenumerationskrav

Vid inloggning kontrollerar portalen att ditt konto uppfyller alla tre kriterier:

  • Giltigt BBID-konto

  • Aktiv Core-, Complete- eller Max -prenumeration

    • Basics-planen är inte berättigad: Basics-prenumeranter kan inte komma åt Developer Portal eftersom de inte kan skapa projekt och sessioner, vilket är kritiska åtgärder för de flesta integrationer. Uppgradera till Core, Complete eller Max för att få åtkomst.

    • Programvaruutvecklare och partners: Om du behöver en speciell NFR-licens via Bluebeam Partnerships måste du begära åtkomst till Bluebeam Developer Portal.

  • Godkänd region: US, AU, DE, UK och SE

Alla nya appar skapas i Sandbox-miljön som standard. Sandbox ger dig ett dedikerat utrymme för att bygga och testa din integration säkert innan den når slutanvändare.

  • Sandbox-autentiseringsuppgifterna förblir konsekventa när din app flyttas till produktion.

  • Vid lansering till produktion kommer frekvensgränserna att anpassas för att support verkliga användningsbegränsningar.

  • Appar finns kvar i Sandbox tills du uttryckligen begär produktionsgodkännande (se Steg 6).

Appskapandeflödet har omdesignats. Formuläret Skapa ansökan visar endast de fält som är relevanta för Bluebeam-integrationer.

Plattform och regioner

  1. Gå till My Apps och välj Skapa applikation.

  2. Välj den API-instans som matchar din region när du skapar din applikation:


Registreringsformulärfält

  1. Fyll i registreringsformulärets fält:

    • Applikationsnamn: Ange upp till 90 tecken.

    • Beskrivning: Ange högst 300 tecken.

    • Region: Välj Bluebeam API-instansen för din region.

    • Omdirigerings-URL (er): Ange kommaavgränsade värden eller tryck på Retur – portalen organiserar dem i en sidindelad lista.

    • Testar du med Postman? För omdirigerings-URI, använd https://oauth.pstmn.io/v1/callback. Din produktionsapp kommer att använda en annan URI.

Autentiseringsanteckningar

  1. Bluebeam API har endast support för följande val för Grant Type:

    • Authorization Code: Alla API-anrop använder OAuth 2.0; användare beviljar din app behörighet att agera å deras vägnar.

    • Refresh Token

  2. Omdirigerings-URI: Använd https://oauth.pstmn.io/v1/callback
    Denna URI används specifikt för att göra anrop i Postman. För andra API-verktyg eller din app krävs en annan URI.

  3. Välj Skapa program för att skicka formuläret.
    När formuläret har skickats in får du ett e-postmeddelande från MuleSoft med ämnet: "Programregistrering godkänd". Vänligen ignorera ignorera e-postmeddelandet. Det är en oönskad bieffekt av att använda vår standardlösning.

  4. Hämta inloggningsuppgifter. Nu bör du se din nyskapade app i listan (om du inte ser den, uppdatera webbläsaren). Klicka var som helst på applínjen, så öppnas detaljsidan där du kan se ditt klient-ID och din klienthemlighet.

  5. Om du använder Postman för testning, hämta 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. Skriptet är en samling av alla tillgängliga Bluebeam API-anrop. I Postman går du till File > Import och släpper skriptet.

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

    4. Välj fliken Authorization för att konfigurera en ny token i Postman.

      Se autentiseringsguiden för mer information om autentisering. Autentiseringsguiden hänvisar till parametrarna för begäran – i Postman kallas dessa för variabler.
      Du kan antingen konfigurera en miljö i Postman för att skapa variabler för din auktorisering, eller så kan du manuellt fylla i de Closedvärden som krävs.

      Obligatoriska inställningar och värden i Postman:

      • Auth-typ: Måste vara OAuth 2.0

      • Grant Type: Authorization Code

      • Token Name: kod

      • Grant type: Authorization Code

      • Authorize using browser måste vara aktiverat.

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

      • Access Token URL: https://api.bluebeam.com/oauth2/token

      • Client ID: Det klient-id som har erhållits under registreringsprocessen för appen

      • Client Secret: Den klienthemlighet som har erhållits under registreringsprocessen för appen

      • Scope: Omfång för Studio-slutpunkter, som minst krävs offline_access

      • State: Status

      • Client Authentication: Skicka klientens autentiseringsuppgifter i brödtexten

    5. Bläddra till nederkant och välj Hämta ny åtkomsttoken.
    6. Logga in med ditt BBID och välj 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.
Tokens utgångsdatum
Tokens upphör att gälla efter 1 timme, så om dina anrop slutar att fungera, gå igenom processen igen för att få en ny token. För att konfigurera OAuth för att använda Refresh-tokens, se vår autentiseringsguide .

Tabellen Mina appar har uppdaterats med ytterligare kolumner så att du snabbt kan få en överblick över viktig appinformation.

  • Namn: Ditt skapade appnamn

  • Klient-ID: Den unika identifieraren som används i alla API-förfrågningar

  • Miljö: Aktuell status (Sandlåda, Väntande eller Produktion)

  • Skapad den: Datumet då appen skapades

  • Region: API-regionen som din app skapas i.

  • Åtgärder: Välj att redigera, radera, visa autentiseringsuppgifter eller begära produktionsgodkännande

I tabellens nederkant kan du se föregående och nästa sida om du hanterar flera appar.

Sök slutpunkter

Ett nytt sökfält för nyckelord låter dig söka igenom alla slutpunkter och parametrar utan att behöva bläddra igenom hela referensen. Skriv ett nyckelord (t.ex. sessioner, markeringar) för att gå till den relevanta slutpunkten.

Testbegäran

Varje API-slutpunkt innehåller nu en knapp för testbegäran. Välj den för att öppna en panel i webbläsaren där du kan:

  • Fyll i frågeparametrar och begärandetexter

  • Utför live-API-anrop direkt från dokumentationen

  • Visa hela svaret direkt

  • Växla mellan programmeringsspråk (Python, cURL och mer)

Nu tillgängligt: Markeringarnas API-slutpunkter är inte längre i Beta och är tillgängliga för alla utvecklare. Ingen ytterligare åtkomst krävs.

När din app har byggts och testats i begränsat läge väljer du Begär produktionsgodkännande på din apps detaljsida i Mina appar. Detta öppnar ett föradresserat e-postmeddelande till integrations@bluebeam.com i din standard-e-postklient.

Du måste inkludera följande information i e-postmeddelandet:

#

Krav

Vad man ska tillhandahålla

1

Offentlig eller privat?

Publikt listad i Integrations Directory, eller begränsad till en privat publik?

2

Framtida uppdateringar eller versioner

Planerad utgivningskadens, kommande funktioner eller versionshanteringsstrategi

3a

Loggar

Samlar du in loggar? (Ja/Nej)

3b

Beräknad användning

Förväntad API-anropsvolym: anrop per timme och/eller per dag

3c

Felsituationer och policyer för återförsök

Hur din app hanterar fel, tidsgränser och återförsök

3D

Tjänstekonto/superanvändaranvändning

Alla tjänstkonton eller privilegierade användare som appen förlitar sig på

3:e

Omfattningar och behörigheter

Alla OAuth-omfattningar din app begär och motivering för varje

4a

Beskrivning

En tydlig, användarvänlig beskrivning av vad din app gör för användare.

4 miljarder

Supportkontakt

E-post eller URL där användare kan kontakta ditt supportteam.

4c

Regioner som stöds

Alla Bluebeam API-regioner din app kommer att betjäna

5

Inspelad demo

En skärminspelning som demonstrerar din apps kärnfunktionalitet.

6

Korsförsäljnings-/kampanjintresse

Intresse för sammarknadsföring eller gemensamma marknadsföringsaktiviteter med Bluebeam.

7

Valfri feedback

Ytterligare kontext eller kommentarer för granskningsteamet

Appstatus efter inlämning

  • Appstatus ändras till Väntar på när godkännandebegäran har skickats in.

  • Efter slutgiltigt godkännande publiceras din app i produktion.

  • Du kommer att få ett e-postmeddelande om att din integrationsapp har godkänts, och statusen kommer att ändras till Produktion i portalen.

 

Se även:


Resurser

Revu 21

Utvecklarportalen

Utvecklarportalen

Den här sidan är din guide till vår nya Developer Portal.