Premiers pas avec le Bluebeam Developer Portal

Lorsque vous vous connectez avec vos identifiants BBID via Okta, le portail vérifie instantanément votre éligibilité. Aucune demande de prise en main manuelle ou d'e-mail à l'équipe des partenariats n'est requise, sauf si vous êtes un développeur de logiciels et/ou un partenaire.

Conditions d'abonnement

Lors de la connexion, le portail vérifie que votre compte répond aux trois critères :

• Compte BBID valide

• Abonnement Core, Complete ou Max actif

  • Formule Basics non éligible : les abonnés Basics ne peuvent pas accéder au Developer Portal, car ils ne peuvent pas procéder à la Création de Projets et de Sessions, ce qui est essentiel pour la plupart des intégrations. Passez à Core, Complete ou Max pour y accéder.

  • Développeurs de logiciels et partenaires : si vous avez besoin d'une licence NFR spéciale par l'intermédiaire des partenariats Bluebeam, vous devrez demander l'accès au Bluebeam Developer Portal.

• Zone éligible : US, AU, DE, UK et SE

La création de toutes les nouvelles applications se fait par défaut dans l'environnement Sandbox. Sandbox vous offre un espace dédié pour construire et tester votre intégration en toute sécurité avant qu'elle n'atteigne les utilisateurs finaux.

• Les identifiants Sandbox resteront identiques lorsque votre application sera transférée en Production.

• Lors du passage en Production, les limites de débit seront ajustées pour fournir une assistance aux contraintes d’utilisation réelles.

• Les applications restent dans l'environnement Sandbox tant que vous ne demandez pas explicitement l'approbation de Production (voir Étape 6).

Le processus de création d'applications a été repensé. Le formulaire de création d'applications affiche uniquement les champs pertinents pour les intégrations Bluebeam.

Plateforme et zones géographiques

1. Allez dans **My Apps** et sélectionnez **Création d'application**.

2. Sélectionnez l'instance d'API qui correspond à votre zone lors de la création de votre application :
   

   • États-Unis : https://api.bluebeam.com

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

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

   • Royaume-Uni : https://api.bluebeamstudio.co.uk

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

   
   

Champs de formulaire d'inscription

3. Remplir les Champs de formulaire :

   • Nom de l'application : Saisissez jusqu'à 90 caractères.

   • Description : saisissez jusqu'à 300 caractères.

   • Zone : Sélectionnez l’instance API Bluebeam de votre région.

   • URL(s) de redirection : Saisissez des valeurs séparées par des virgules ou appuyez sur Entrée – le portail les organise dans une liste paginée.

   • Tests avec Postman ? Pour l'URI de redirection, utilisez https://oauth.pstmn.io/v1/callback. Votre application de production utilisera une URI différente.

Remarques sur l'authentification

4. L'API Bluebeam ne fournit que l'assistance pour les sélections suivantes pour le type d'autorisation :

   • Code d'autorisation : tous les appels d'API utilisent OAuth 2.0 ; les utilisateurs accordent à votre application l'autorisation d'agir en leur nom.

   • Actualiser le jeton

5. URI de redirection : Utilisez https://oauth.pstmn.io/v1/callback
   Cette URI est spécifique aux appels effectués dans Postman. D'autres outils d'API ou votre application nécessiteront une URI différente.

6. Sélectionner Création de l’application pour soumettre le formulaire.
   Après avoir soumis le formulaire, vous recevrez un e-mail de marque MuleSoft avec pour objet : « Application registration approved ». Veuillez ignorer l'e-mail. C'est un effet secondaire indésirable de l'utilisation de notre solution prête à l'emploi.

7. Obtenir les informations d'identification. Vous devriez maintenant voir votre application en création dans la liste (si vous ne la voyez pas, actualisez votre navigateur). Cliquez n'importe où sur la ligne de l'application, et cela ouvrira la page des détails où vous pouvez afficher votre Client ID et votre Client Secret.
   
   

8. Si vous utilisez Postman pour les tests, obtenez un jeton d'accès via Postman.

   1. Accédez à Postman via leur application de bureau ou leur navigateur et créez un compte gratuit.

   2. Voici un script que vous pouvez importer dans Postman. Ce script est une collection de tous les appels d'API Bluebeam disponibles. Dans Postman, allez dans Fichier > Import, et déposez le script.

   3. Pour obtenir un access_token dans Postman, sélectionnez la collection Bluebeam API (Script xxx) .

   4. Sélectionnez l'onglet Autorisation pour configurer un nouveau jeton dans Postman.
      

      Pour plus d’informations sur l’authentification, consultez le Guide d’authentification. Le Guide d'authentification fait référence à des paramètres de requête, appelés variables dans Postman.
      Vous pouvez soit configurer un environnement dans Postman pour créer des variables pour votre autorisation, soit remplir manuellement les valeurs requises .

      Paramètres et valeurs requises dans Postman:

      • Type d'authentification : doit être OAuth 2.0

      • Type de subvention : code d'autorisation

      • Nom du jeton : code

      • Type d’autorisation : Code d’autorisation

      • L’option Autoriser à l’aide du navigateur doit être activée.

      • URL d’authentification : https://api.bluebeam.com/oauth2/authorize

      • URL du jeton d’accès : https://api.bluebeam.com/oauth2/token

      • Identifiant Client : Identifiant Client reçu pendant le processus d’enregistrement de l’application

      • Clé secrète Client : clé secrète reçue lors de la procédure d'enregistrement de l'application

      • Portée : Portées pour les terminaux de Studio; le minimum requis est offline_access

      • Statut : statut

      • Authentification Client : envoyer les informations d'authentification du client dans le corps

   5. Faites défiler jusqu’en bas et sélectionnez Obtenir un nouveau jeton d’accès.
   6. Effectuez la Connexion avec votre BBID et veuillez sélectionner Autoriser l’accès lorsque le système vous y invite. Vous recevrez un jeton que vous pourrez utiliser dans Postman, notre documentation API ou votre propre code.

Le tableau Mes applications a été mis à jour avec des colonnes supplémentaires afin que vous puissiez voir les détails clés de l’application en un coup d’œil.

• Nom : Nom de votre création d'application

• ID client : l'identifiant unique utilisé dans toutes les requêtes API

• Environnement : le statut actuel (Sandbox, En attente ou Production)

• Date de création : date de création de l'application

• Zone : la zone API dans laquelle votre application fait l'objet d'une Création

• Actions : Sélectionnez pour modifier, supprimer, afficher les informations d’identification ou demander l’approbation de production

En bas du tableau, affichez les pages précédente et suivante si vous gérez plusieurs applications.

Points de terminaison de Rechercher

Une nouvelle barre de Rechercher par mot-clé vous permet d'effectuer des recherches sur tous les points de terminaison et paramètres sans faire défiler la référence complète. Saisissez un mot-clé (par exemple, sessions, annotations) pour accéder au point de terminaison pertinent.

Demande de test

Chaque point de terminaison d'API inclut désormais un bouton de Demande de test. Sélectionnez-le pour ouvrir un panneau dans le navigateur où vous pouvez :

• Remplir les paramètres de requête et les corps de requête

• Exécuter des appels d'API en direct directement à partir de la documentation.

• Vue de la réponse complète en ligne.

• Basculez entre les langages de codage (Python, cURL et plus).

Désormais disponible : les points de terminaison d'API d'Annotations sont hors version bêta et disponibles pour tous les développeurs. Aucun accès supplémentaire n'est requis.

Une fois votre application construite et testée dans Sandbox, sélectionnez Demander l'approbation de production sur la page de détails de votre application dans Mes applications. Cela ouvre un e-mail pré-rempli à integrations@bluebeam.com dans votre client de messagerie par défaut.

Vous devez inclure les informations suivantes dans l'e-mail :

Statut de l'application après la soumission

• Le statut de l'application passe à En attente une fois la demande d'approbation soumise.

• Après approbation finale, votre application est promue en production.

• Vous recevrez un e-mail indiquant que votre application d'intégration est approuvée, et le statut passera à Production dans le Portail.