Inizia nel Bluebeam Developer Portal

L'API Bluebeam è RESTful e attualmente ha 2 categorie di endpoint:

• Autenticazione

• Studio

Esistono URL di base specifici per Area che si Applica a tutti gli endpoint:

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

Ad esempio, https://api.bluebeam.com/publicapi/v1/sessions negli Stati Uniti sarebbe https://api.bluebeamstudio.com.au/publicapi/v1/sessions in Australia.

Autenticazione

Alcune note di alto livello su come gestiamo l'autenticazione:

• Autenticazione con OAuth 2.0

  • Tutte le chiamate API vengono effettuate nel contesto di un utente. Autenticandosi con OAuth, un utente autorizza la tua app ad accedere ai propri dati e a effettuare richieste API per suo conto.

• Tutte le richieste e i corpi delle risposte devono essere in formato JSON. Set l'intestazione Content-Type: application/json su tutte le richieste che hanno corpi.

• Le chiamate API devono essere effettuate tramite HTTPS.

• Consulta la nostra Guida all'autenticazione per iniziare a configurare OAuth 2.0 nella tua app.

Studio

Studio è la nostra piattaforma di collaborazione Nuvola con una connessione diretta alla nostra applicazione desktop di punta: Bluebeam Revu. I nostri endpoint Studio aprono linee di comunicazione per un'integrazione perfetta tra Studio e i tuoi sistemi.

In genere, è possibile considerare le funzionalità offerte dall'API Studio come lo stesso set di funzionalità che un utente otterrebbe tramite l'interfaccia utente grafica di Studio in Revu.

Per saperne di più su Studio, visita la nostra pagina delle FAQ su Studio.

Questa procedura utilizza Postman come esempio, ma è possibile utilizzare altri programmi API per completarla.

Per ottenere un token di accesso, segui questi passaggi:

1. Creazione un account Bluebeam e richiedi l'accesso al Bluebeam Developer Portal, se non l'hai già fatto.

2. Vai su developers.bluebeam.it ed effettua l'accesso.

3. Richiedi l'accesso e crea un ID client.

   1. Vai su Le mie app e clicca su Richiedi accesso.

   2. Riempi il modulo Richiedi accesso (vedi screenshot qui sotto). Seleziona l'istanza API Bluebeam associata alla tua regione specifica.

      Bluebeam Developer API è il server statunitense.
      
      
   L'API Bluebeam supporta solo le seguenti selezioni per il tipo di concessione:
   • Codice di autorizzazione
   • Aggiorna token

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

   4. Seleziona Richiedi per inviare il modulo.
      

   Email di approvazione
   Dopo aver selezionato Richiesta, riceverai un'e-mail a marchio MuleSoft con l'oggetto: "Registrazione dell'applicazione approvata" – ignora. È un altro effetto collaterale indesiderato dell'utilizzo della nostra soluzione pronta all'uso.
   

4. Ottieni le credenziali. Ora dovresti vedere la tua app appena registrata nell'elenco (se non la vedi, aggiorna il browser). Passa il mouse sulla chiave per ottenere le tue credenziali.

   
   

5. 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 fai clic su Ottieni nuovo token di accesso.
      

   6. Accedi con il tuo BBID e fai clic su Consenti accesso quando richiesto. Ti verrà presentato un token che potrai utilizzare in Postman, nella nostra documentazione API o nel tuo codice.

Ecco una procedura dettagliata per migrare un'integrazione esistente sulla nostra nuova piattaforma.

1. Creazione di un account BBID, se non l'hai già fatto.

2. Vai su developers.bluebeam.it ed effettua l'accesso.

3. Registra una nuova app.

   1. Vai su Le mie app e seleziona Richiedi accesso.

   2. Riempi il modulo Richiedi accesso (vedi schermata qui sotto). Seleziona l'istanza API Bluebeam associata alla tua Area specifica.
      

      Nota per il tipo di sovvenzione:

      Seleziona solo le caselle accanto a:

      • Codice di autorizzazione
      • Aggiorna token

   3. Seleziona Richiedi per inviare il modulo.
      

4. Ottieni le credenziali. Ora dovresti vedere la tua app appena registrata nell'elenco. Passa il mouse sulla chiave per ottenere le tue credenziali.

   
   

5. Aggiorna l'integrazione esistente con i nuovi percorsi API per l'autorizzazione e gli endpoint Studio elencati di seguito.
   

   Server degli Stati Uniti
   Ambiente	Percorso base originale	Nuova rotta di base
   Autenticazione – produzione (USA)	https://authserver.bluebeam.com/auth/oauth/authorize	https://api.bluebeam.com/oauth2/authorize
   Autenticazione – produzione (USA)	https://authserver.bluebeam.com/auth/token	https://api.bluebeam.com/oauth2/token
   Studio – produzione (USA)	https://studioapi.bluebeam.com:443/publicapi/v1	https://api.bluebeam.com/publicapi/v1

6. Ovunque tu abbia configurato il tuo Client ID e Client Secret legacy nell'integrazione, sostituiscili con il tuo nuovo Client ID e Client Secret.

7. Nelle chiamate API, aggiungi un'intestazione denominata "client_id" con il valore del tuo nuovo ID client. Questa operazione è obbligatoria per tutte le richieste che arrivano sulla nuova piattaforma.

   Nota
   Stiamo ancora lavorando per rendere i nostri messaggi di errore più accurati e significativi, ma nel frattempo, se invii la tua richiesta senza l'intestazione "client_id" , vedrai un messaggio di errore come questo:
   

   Copia

   {
       "msg": "Internal Server Error"
   }

8. La nostra nuova piattaforma gestisce l'autenticazione in modo leggermente diverso rispetto alla vecchia piattaforma, pertanto ti consigliamo di consultare la nostra nuova Guida all'autenticazione . Due cambiamenti degni di nota:

   • Abbiamo Introduzione un ambito offline_access per i token di aggiornamento (vedere il passaggio 1 nella Guida all'autenticazione ).

   • Le risposte del nostro endpoint token sono cambiate (vedere la Guida all'autenticazione per esempi di risposte).

9. Se tutto è configurato correttamente, dovresti ricevere una risposta identica alla risposta della precedente API Studio per tutti gli endpoint Studio.
   Ad esempio, se hai richiesto un elenco di progetti Studio, il corpo della tua risposta sarà simile a questo:
   

   Copia

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

10. Prova la tua app e facci sapere se riscontri problemi.