Comience a usar el Bluebeam Developer Portal

El Bluebeam Developer Portal, para el desarrollo de integraciones, solo está disponible para clientes activos, socios de canal y socios de software en las regiones de EE. UU., AU, DE, Reino Unido y SE.

Esta página es su guía a través de nuestro nuevo Developer Portal. Recomendamos abrirla en una pestaña independiente mientras sigues los pasos en otra pestaña.

Para comenzar, Creación una cuenta de Bluebeam y solicite acceso al Bluebeam Developer Portal, si aún no lo ha hecho.

Elige tu camino:

La API de Bluebeam es RESTful y actualmente tiene 2 categorías de puntos finales:

  • Autenticación

  • Studio

Hay URL base específicas de cada región que se aplican a todos los puntos finales:

- EE. UU.: 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

Por ejemplo, https://api.bluebeam.com/publicapi/v1/sessions en EE. UU. sería https://api.bluebeamstudio.com.au/publicapi/v1/sessions en AU.

Autenticación

Algunas notas de alto nivel sobre cómo manejamos la autenticación:

  • Autenticación con OAuth 2.0

    • Todas las llamadas a API se realizan bajo el contexto de un usuario. Al autenticarse con OAuth, un usuario otorga permiso a su aplicación para obtener acceso a sus datos y realizar solicitudes de API en su nombre.

  • Todas las solicitudes y cuerpos de respuesta deben tener formato JSON. Set el encabezado Content-Type: application/json en todas las solicitudes que tengan cuerpos.

  • Las llamadas a la API deben realizarse a través de HTTPS.

  • Consulta nuestra Guía de autenticación para comenzar a configurar OAuth 2.0 en tu aplicación.

Studio

Studio es nuestra plataforma de colaboración en la nube con una conexión directa a nuestra aplicación de escritorio insignia: Bluebeam Revu. Nuestros puntos finales de Studio abren líneas de comunicación para una integración perfecta entre Studio y sus sistemas.

En general, puedes pensar en la funcionalidad ofrecida por la API de Studio como el mismo conjunto de funcionalidades que un usuario obtendría a través de la GUI de Studio en Revu.

Para obtener más información sobre Studio, visita nuestra página de preguntas frecuentes de Studio.

Este procedimiento utiliza Postman como ejemplo, pero se pueden usar otros programas de software de API para completar este procedimiento.

Para obtener un token de acceso, sigue estos pasos:

Este procedimiento requiere datos de la Guía de autenticación.

  1. Creación de una cuenta de Bluebeam y solicite acceso al Developer Portal de Bluebeam, si aún no lo ha hecho.

  2. Vaya a developers.bluebeam.es e inicie sesión.

  3. Solicita acceso y crea un ID de cliente.

    1. Vaya a Mis aplicaciones y click en Solicitar acceso.

    2. Rellena el formulario de Solicitud de acceso (ver la captura de pantalla a continuación). Selecciona la instancia de la API de Bluebeam asociada a tu región específica.

      La API para desarrolladores de Bluebeam está en el servidor de EE. UU.

      3. La API de Bluebeam solo admite las siguientes opciones para el tipo de concesión:
      • Código de autorización
      • Token de actualización

    3. URI de redireccionamiento: utiliza https://oauth.pstmn.io/v1/callback

      Este URI es específico para hacer llamadas en Postman. Las herramientas de API alternativas o tu aplicación requerirán un URI diferente.

    4. Seleccione Solicitar para enviar el formulario.

      5. Correo electrónico de aprobación
      Al seleccionar Solicitar, recibirá un correo electrónico de la marca MuleSoft con el asunto: "Registro de solicitud aprobado"; ignórelo. Es otro efecto secundario no deseado de utilizar nuestra solución lista para usar.

  4. Obtener credenciales. Ahora deberías ver tu aplicación recién registrada en la lista (si no la ves, actualiza tu navegador). Pase el cursor sobre la clave para obtener sus credenciales.


  5. Obtenga un token de acceso a través de Postman.

    1. Acceda a Postman a través de su aplicación de escritorio o navegador y Creación una cuenta gratuita.

    2. Aquí tienes un script que puedes importar a Postman. Este script es una colección de todas las llamadas a la API de Bluebeam disponibles. En Postman, ve a Archivo > Importar y suelta el script.

    3. Para obtener un access_token en Postman, Seleccionar la colección Bluebeam API (Creación de scripts x.x.x).

    4. Selecciona la pestaña Autorización para configurar un nuevo token en Postman.

      Para obtener más información sobre la autenticación, consulta la Guía de autenticación. La Guía de autenticación incluye referencias a los parámetros de solicitud, conocidos como variables en Postman.
      Puedes configurar un entorno en Postman para crear variables para tu autorización, o puedes rellenar manualmente los valores requeridosClosed.

      Configuración y valores requeridos en Postman:

      • Tipo de autenticación: debe ser OAuth 2.0

      • Tipo de concesión: código de autorización

      • Nombre del token: code

      • Tipo de concesión: código de autorización

      • Se debe habilitar la opción Autorizar mediante el navegador.

      • URL de autenticación: https://api.bluebeam.com/oauth2/authorize

      • URL del token de acceso: https://api.bluebeam.com/oauth2/token

      • ID de cliente: ID de cliente recibido durante el proceso de registro de la aplicación

      • Secreto del cliente: secreto del cliente recibido durante el proceso de registro de la aplicación

      • Alcance: alcances para puntos finales de Studio; el mínimo requerido es offline_access

      • Estado: estado

      • Autenticación del cliente: envía credenciales del cliente en el cuerpo

    5. Desplázate hasta la parte inferior y haz clic en Obtener nuevo token de acceso.

    6. Inicie sesión con su BBID y click en Permitir acceso cuando se le solicite. Se le presentará un token que puede usar en Postman, nuestros documentos de API o su propio código.

Vencimiento del token
Los tokens caducan después de 1 hora, por lo que si sus llamadas dejan de funcionar, repita el proceso para obtener un nuevo token. Para configurar OAuth para usar tokens de actualización, consulte nuestra Guía de autenticación .

A continuación se muestra un proceso paso a paso para migrar una integración existente a nuestra nueva plataforma.

  1. Creación de una cuenta BBID, si aún no lo has hecho.

  2. Vaya a developers.bluebeam.es e inicie sesión.

  3. Registrar una nueva aplicación.

    1. Vaya a Mis aplicaciones y seleccione Solicitar acceso.

    2. Rellene el formulario de solicitud de acceso (ver captura de pantalla a continuación). Seleccione la instancia de API de Bluebeam asociada con su región específica.

      Nota para el tipo de subvención:

      Seleccione únicamente las casillas junto a:

      • Código de autorización
      • Token de actualización

    3. Seleccione Solicitar para enviar el formulario.

  4. Obtener credenciales. Ahora deberías ver tu aplicación recién registrada en la lista. Pase el cursor sobre la clave para obtener sus credenciales.


  5. Actualice su integración existente con las nuevas rutas de API para autorización y puntos finales de Studio que se enumeran a continuación.

    Servidores de Estados Unidos

    Ambiente

    Ruta base original

    Nueva ruta base

    Aut. – Producción (EE. UU.)

    https://authserver.bluebeam.com/auth/oauth/authorize

    https://api.bluebeam.com/oauth2/authorize

    Aut. – Producción (EE. UU.)

    https://authserver.bluebeam.com/auth/token

    https://api.bluebeam.com/oauth2/token

    Studio – Producción (EE. UU.)

    https://studioapi.bluebeam.com:443/publicapi/v1

    https://api.bluebeam.com/publicapi/v1

  6. En cualquier lugar donde tenga configurados su ID de cliente y secreto de cliente heredados en su integración, reemplácelos con su nuevo ID de cliente y secreto.

  7. En sus llamadas API, agregue un encabezado llamado "client_id" con el valor de su nuevo ID de cliente. Esto es necesario para todas las solicitudes que llegan a la nueva plataforma.

    Nota
    Seguimos trabajando para que nuestros mensajes de error sean más precisos y significativos, pero mientras tanto, si envía su solicitud sin el encabezado "client_id" , verá un mensaje de error como este:

    copy
    {
        "msg": "Internal Server Error"
    }

  8. Nuestra nueva plataforma maneja la autenticación de manera ligeramente diferente a nuestra plataforma anterior, por lo que recomendamos revisar nuestra nueva Guía de autenticación . Dos cambios notables:

    • Hemos presentado un ámbito offline_access para tokens de actualización (consulte el Paso 1 en la Guía de autenticación ).

    • Nuestras respuestas de punto final de token han cambiado (consulte la Guía de autenticación para ver ejemplos de respuestas).

  9. Si todo está configurado correctamente, debería recibir una respuesta idéntica a la respuesta de la API de Studio anterior para todos los puntos finales de Studio.
    Por ejemplo, si solicitaste una lista de Proyectos de Studio, el cuerpo de tu respuesta se vería así:

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

  10. Prueba tu aplicación y avísanos si tienes algún problema.

 

Ver también:


Recursos

Revu 21

Developer Portal

Developer Portal

Esta página es una guía para nuestro nuevo Developer Portal.