Aan de slag in de Bluebeam Developer Portal

De Bluebeam Developer Portal, voor integratieontwikkeling, is alleen beschikbaar voor actieve klanten, kanaalpartners en softwarepartners in de regio's VS, AU, DE, VK en SE.

Deze pagina is uw gids door onze nieuwe Developer Portal. Wij adviseren u om het in een apart tabblad te openen en de stappen in een apart tabblad te doorlopen.

Om te beginnen maakt u een Bluebeam-account aan en vraagt u toegang aan tot de Bluebeam Developer Portal (als u dat nog niet hebt gedaan).

Kies je pad:

De Bluebeam API is RESTful en heeft momenteel 2 categorieën eindpunten:

  • Verificatie

  • Studio

Er zijn regiospecifieke basis-URL's die Toepassen op alle eindpunten:

- VS: https://api.bluebeam.com

- DU: https://api.bluebeamstudio.de

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

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

- SE: https://api.bluebeamstudio.se

Bijvoorbeeld: https://api.bluebeam.com/publicapi/v1/sessions in de VS zou https://api.bluebeamstudio.com.au/publicapi/v1/sessions in Australië zijn.

Verificatie

Een paar algemene opmerkingen over hoe wij authenticatie afhandelen:

  • Authenticatie met OAuth 2.0

    • Alle API-aanroepen worden gedaan binnen de context van een gebruiker. Door te authenticeren met OAuth geeft een gebruiker uw app toestemming om toegang te krijgen tot zijn gegevens en namens hem API-verzoeken te doen.

  • Alle verzoeken en antwoordteksten moeten in JSON-formaat zijn. Set de Content-Type: application/json-header in op alle aanvragen met een body.

  • API-aanroepen moeten via HTTPS worden gedaan.

  • Bekijk onze Authenticatiehandleiding om te beginnen met het instellen van OAuth 2.0 in uw app.

Studio

Studio is ons platform voor samenwerking in de Wolk met een directe verbinding met onze belangrijkste desktoptoepassing: Bluebeam Revu. Onze Studio-eindpunten openen communicatielijnen voor naadloze integratie tussen Studio en uw systemen.

Over het algemeen kun je de functionaliteit die de Studio API biedt, beschouwen als dezelfde functionaliteit die een gebruiker via de Studio GUI in Revu krijgt.

Voor meer informatie over Studio kunt u terecht op onze Studio FAQ-pagina.

Deze procedure gebruikt Postman als voorbeeld, maar andere API-softwareprogramma's kunnen worden gebruikt om deze procedure te voltooien.

Volg deze stappen om een toegangstoken te krijgen:

Deze procedure vereist gegevens uit de Authenticatiehandleiding.

  1. Maak een Bluebeam-account aan en vraag toegang aan tot de Bluebeam Developer Portal, als u dat nog niet hebt gedaan.

  2. Ga naar developers.bluebeam.nl en log in.

  3. Vraag toegang aan en maak een Client-ID aan.

    1. Ga naar Mijn apps en klik op Toegang aanvragen.

    2. Vul het aanvraagformulier voor toegang in (zie onderstaande schermafbeelding). Selecteer de Bluebeam API-instantie die is gekoppeld aan uw specifieke regio.

      Bluebeam Developer API is de Amerikaanse server.

      3. Bluebeam API ondersteunt alleen de volgende selecties voor Grant Type:
      • Autorisatiecode
      • Token vernieuwen

    3. Redirect URI: gebruik https://oauth.pstmn.io/v1/callback

      Deze URI is specifiek voor het maken van oproepen in Postman. Andere API-tools of je app vereisen een andere URI.

    4. Selecteer 'Aanvraag' om het formulier te verzenden.

      5. Goedkeuringsmail
      Wanneer u op Aanvragen selecteert, ontvangt u een e-mail met het MuleSoft-logo met als onderwerp: "Registratie aanvraag goedgekeurd". U kunt deze e-mail negeren. Dit is een ander ongewenst neveneffect van het gebruik van onze kant-en-klare oplossing.

  4. Vraag om referenties. Nu zou u de nieuw geregistreerde app in de lijst moeten zien (als u deze niet ziet, vernieuw dan uw browser). Beweeg uw muis over de sleutel om uw inloggegevens te bekijken.


  5. Vraag een toegangstoken aan via Postman.

    1. U kunt Postman openen via de desktop-app of browser en een gratis account maken.

    2. Hier is een script dat je in Postman kunt importeren. Dit script is een verzameling van alle beschikbare Bluebeam API-aanroepen. Ga in Postman naar Bestand > Importeren en zet het script daar neer.

    3. Om een access_token in Postman te verkrijgen, Selecteren de Bluebeam API (Scripts xxx) -verzameling.

    4. Selecteer het tabblad Autorisatie om een nieuw token te configureren in Postman.

      Voor meer informatie over authenticatie, zie de Authenticatiegids. De Authenticatiegids verwijst naar verzoekparameters; deze staan bekend als variabelen in Postman.
      Je kunt ofwel een omgeving in Postman instellen om variabelen voor je autorisatie te maken, of je kunt handmatig de Closedvereiste waarden invullen.

      Vereiste instellingen en waarden in Postman:

      • Authenticatietype: Moet OAuth 2.0 zijn.

      • Grant Type: Authorization Code

      • Tokennaam: code

      • Toekenningscode: Authorisatiecode

      • Autoriseren via de browser moet ingeschakeld zijn.

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

      • URL voor toegangstoken: https://api.bluebeam.com/oauth2/token

      • Client-id: Client-id die is ontvangen tijdens het registratieproces van de app

      • Client Secret: Client Secret ontvangen tijdens het app-registratieproces

      • Scope: Scopes voor Studio-eindpunten; het minimum vereiste is offline_access

      • Status: Status

      • Clientverificatie: verzend klantgegevens in de hoofdtekst

    5. Scroll naar beneden en klik op Nieuw toegangstoken ophalen.

    6. Meld u aan met uw BBID en klik op Toegang toestaan wanneer u daarom wordt gevraagd. U ontvangt een token dat u kunt gebruiken in Postman, onze API-documentatie of uw eigen code.

Tokenvervaldatum
Tokens verlopen na 1 uur. Als uw oproepen niet meer werken, doorloopt u het proces opnieuw om een nieuw token te krijgen. Raadpleeg onze Authenticatiehandleiding voor informatie over het instellen van OAuth voor het gebruik van vernieuwingstokens.

Hieronder vindt u een stapsgewijs proces voor het migreren van een bestaande integratie naar ons nieuwe platform.

  1. Maak een BBID-account aan, als u dat nog niet heeft gedaan.

  2. Ga naar developers.bluebeam.nl en log in.

  3. Registreer een nieuwe app.

    1. Ga naar Mijn apps en selecteer Toegang aanvragen.

    2. Vul het formulier 'Toegang aanvragen' in (zie onderstaande schermafbeelding). Selecteer de Bluebeam API-instantie die aan uw specifieke regio is gekoppeld.

      Opmerking voor subsidietype:

      Selecteer alleen de vakjes naast:

      • Autorisatiecode
      • Token vernieuwen

    3. Selecteer 'Aanvraag' om het formulier te verzenden.

  4. Vraag om referenties. Nu zou u uw nieuw geregistreerde app in de lijst moeten zien. Beweeg uw muis over de sleutel om uw inloggegevens te bekijken.


  5. Werk uw bestaande integratie bij met de nieuwe API-routes voor autorisatie en Studio-eindpunten die hieronder worden vermeld.

    Servers in de Verenigde Staten

    Omgeving

    Originele basisroute

    Nieuwe basisroute

    Auth – Productie (VS)

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

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

    Auth – Productie (VS)

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

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

    Studio – Productie (VS)

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

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

  6. Overal waar u uw oude Client ID en Client Secret in uw integratie hebt geconfigureerd, kunt u deze vervangen door uw nieuwe Client ID en Secret.

  7. Voeg in uw API-aanroepen een header met de naam "client_id" toe met de waarde van uw nieuwe Client ID. Dit is vereist voor alle verzoeken die het nieuwe platform bereiken.

    Opmerking
    We werken er nog steeds aan om onze foutmeldingen nauwkeuriger en betekenisvoller te maken, maar als u in de tussentijd uw verzoek verzendt zonder de header "client_id" , ziet u een foutmelding als deze:

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

  8. Ons nieuwe platform verwerkt authenticatie iets anders dan ons oude platform. Daarom raden we u aan onze nieuwe Authenticatiehandleiding te raadplegen. Twee opmerkelijke veranderingen:

  9. Als alles correct is geconfigureerd, ontvangt u voor alle Studio-eindpunten een identiek antwoord als het antwoord van de vorige Studio API.
    Als u bijvoorbeeld een lijst met Studio-projecten hebt aangevraagd, ziet uw antwoord er ongeveer zo uit:

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

  10. Test uw app en laat het ons weten als u problemen tegenkomt.

 

Zie ook:


Hulpbronnen

Revu 21

Developer Portal

Developer Portal

Deze pagina is uw gids door ons nieuwe Developer Portal.