Inizia nel Bluebeam Developer Portal

Quando accedi con le tue credenziali BBID tramite Okta, il portale verifica immediatamente la tua idoneità. Non è richiesta alcuna richiesta di onboarding manuale o e-mail al team Partnership, a meno che tu non sia uno sviluppatore software e/o un partner.

Requisiti di abbonamento

Al momento dell'accesso, il portale verifica che il tuo account soddisfi tutti e tre i criteri:

• Account BBID valido

• Abbonamento Core, Complete o Max attivo

  • Piano Basics non idoneo: gli abbonati Basics non possono accedere al Developer Portal perché non possono effettuare la creazione di progetti e sessioni, operazioni fondamentali per la maggior parte delle integrazioni. Esegui l'upgrade a Core, Complete o Max per ottenere l'accesso.

  • Sviluppatori di software e partner: se hai bisogno di una licenza NFR speciale tramite le partnership Bluebeam, dovrai richiedere l'accesso al Bluebeam Developer Portal.

• Area idonea: USA, AU, DE, UK e SE

Tutte le nuove app vengono create nell'ambiente Sandbox per impostazione predefinita. Sandbox ti offre uno spazio dedicato per costruire e testare in sicurezza la tua integrazione prima che raggiunga gli utenti finali.

• Le credenziali della sandbox rimarranno coerenti quando l'app verrà spostata in Production.

• Quando si esegue la promozione in Produzione, i limiti di frequenza si adegueranno per supportare i vincoli di utilizzo reali.

• Le app rimangono in Sandbox finché non richiedi esplicitamente l'approvazione per la produzione (vedi Passaggio 6).

Il flusso di creazione dell'app è stato riprogettato. Il modulo Creazione applicazione mostra solo i campi pertinenti alle integrazioni Bluebeam.

Piattaforma e aree

1. Vai a My Apps e seleziona Creazione applicazione.

2. Seleziona l'istanza API che corrisponde alla tua Area durante la creazione della tua applicazione:
   

   • Stati Uniti: https://api.bluebeam.com

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

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

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

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

   
   

Campi del modulo di registrazione

3. Riempi i campi del modulo di registrazione:

   • Nome applicazione: immettere fino a 90 caratteri.

   • Descrizione: inserire fino a 300 caratteri.

   • Area: Seleziona l'istanza API Bluebeam per la tua area.

   • URL di reindirizzamento: inserisci valori separati da virgola o premi Invio – il portale li organizza in un elenco paginato.

   • Stai testando con Postman? Per l'URI di reindirizzamento, utilizza https://oauth.pstmn.io/v1/callback. La tua app di produzione utilizzerà un URI diverso.

Nota sull'autenticazione

4. Bluebeam API supporta solo le seguenti selezioni per il Tipo di concessione:

   • Codice di autorizzazione: tutte le chiamate API utilizzano OAuth 2.0; gli utenti concedono alla tua app l'autorizzazione ad agire per loro conto.

   • Aggiorna token

5. URI di reindirizzamento: Utilizzare https://oauth.pstmn.io/v1/callback
   Questo URI è specifico per effettuare chiamate in Postman. Strumenti API alternativi o la tua app richiederanno un URI diverso.

6. Seleziona Crea applicazione per inviare il modulo.
   Dopo aver inviato il modulo, riceverai un'e-mail a marchio MuleSoft con l'oggetto: "Registrazione applicazione approvata". Ignorare l'e-mail. È un effetto collaterale indesiderato dell'utilizzo della nostra soluzione pronta all'uso.

7. Ottieni le credenziali. Ora dovresti visualizzare l'app di nuova creazione nell'elenco (se non la visualizzi, aggiorna il browser). Fai clic in qualsiasi punto della linea dell'app e si aprirà la pagina dei dettagli in cui puoi visualizzare l'ID client e la chiave privata client.
   
   

8. Se utilizzi Postman per i test, ottieni un token di accesso tramite Postman.

   1. Accedi a Postman tramite l'app desktop o il browser e Creazione un account gratuito.

   2. Ecco uno script che puoi importare in Postman. Questo script è una raccolta di tutte le chiamate API di Bluebeam disponibili. In Postman, vai su File > Importa e rilascia lo script.

   3. Per ottenere un access_token in Postman, Seleziona la raccolta Bluebeam API (Script x.x.x).

   4. Seleziona la Tab Autorizzazione per configurare un nuovo token in Postman.
      

      Per ulteriori informazioni sull'autenticazione, consulta la Guida all'autenticazione. La Guida all'autenticazione fa riferimento a parametri di richiesta; questi sono noti come variabili in Postman.
      Puoi configurare un ambiente in Postman per creare variabili per la tua autorizzazione, oppure puoi riempire manualmente i valori richiesti.

      Impostazioni e valori richiesti in Postman:

      • Tipo di autenticazione: deve essere OAuth 2.0

      • Tipo di concessione: codice di autorizzazione

      • Nome del token: codice

      • Tipo di concessione: codice di autorizzazione

      • L'autorizzazione tramite browser deve essere abilitata.

      • URL dell'autenticazione: https://api.bluebeam.com/oauth2/authorize

      • URL del token di accesso: https://api.bluebeam.com/oauth2/token

      • ID cliente: ID cliente ricevuto durante il processo di registrazione dell'App

      • Chiave privata client: chiave privata client ricevuta durante il processo di registrazione dell'app

      • Ambiti: autorizzazioni per gli endpoint di Studio; il requisito minimo è offline_access

      • Stato: stato

      • Autenticazione del cliente: invia le credenziali direttamente nel corpo

   5. Scorri verso il basso e seleziona Ottieni un nuovo token di accesso.
   6. Accedi con il tuo BBID e seleziona Consenti accesso quando richiesto. Ti verrà presentato un token che potrai utilizzare in Postman, nella nostra documentazione API o nel tuo codice.

La tabella Le mie app è stata aggiornata con colonne aggiuntive in modo da poter visualizzare i dettagli chiave dell'app a colpo d'occhio.

• Nome: il nome dell'app di creazione

• ID cliente: l'identificatore univoco utilizzato in tutte le richieste API

• Ambiente: lo stato corrente (Sandbox, In sospeso o Produzione)

• Data di creazione: La data di creazione dell'app

• Area: area API in cui è stata effettuata la creazione dell'app.

• Azioni: seleziona per modificare, eliminare, visualizzare le credenziali o richiedere l'approvazione della produzione

In fondo alla tabella, visualizzare le pagine precedente e successiva se si gestiscono più app.

Endpoint di Ricerca

Una nuova barra di ricerca per parole chiave consente di cercare tra tutti gli endpoint e i parametri senza scorrere l'intera documentazione. Digitare una parola chiave (ad esempio, sessioni, marcature) per passare all'endpoint pertinente.

Richiesta di test

Ogni endpoint API include ora un pulsante Richiesta di test. Seleziona per Apri un Riquadro nel browser dove puoi:

• Riempi i parametri di query e i corpi delle richieste

• Esegui chiamate API in tempo reale direttamente dalla documentazione

• Visualizza la risposta completa in linea

• Passa da un linguaggio di codifica all'altro (Python, cURL e altro)

Ora disponibile: gli endpoint API delle Marcature non sono più in Beta e sono disponibili per tutti gli sviluppatori. Nessun accesso aggiuntivo richiesto.

Una volta che la tua app è stata costruita e testata in Sandbox, seleziona Richiedi approvazione produzione nella pagina dei dettagli della tua app in Le mie app. Si apre un'e-mail preindirizzata a integrations@bluebeam.com nel client di posta elettronica predefinito.

Devi includere le seguenti informazioni nell'email:

Stato dell'app dopo l'inoltro

• Lo stato dell'app cambia in In sospeso una volta inviata la richiesta di approvazione.

• Dopo l'approvazione finale, la tua app viene promossa in produzione.

• Riceverai un'e-mail che la tua app di integrazione è stata approvata e lo stato cambierà in Produzione nel Portale.