Aloita Bluebeam Developer Portalissa

Integraatioiden kehittämiseen tarkoitettu Bluebeam Developer Portal on käytettävissä vain aktiivisille asiakkaille, kanavakumppaneille ja ohjelmistokumppaneille Yhdysvaltojen, Australian, Saksan, Ison-Britannian ja Kaakkois-Euroopan alueilla.

Tämä sivu on oppaasi uudessa Developer Portalissa. Suosittelemme, että Avaa se omalla sarkain, kun käyt läpi vaiheet erillisellä sarkain.

Aloita Luo Bluebeam-tili ja pyytämällä käyttöoikeutta Bluebeam Developer Portal, jos sinulla ei vielä ole sellaista.

Valitse polkusi:

Bluebeam-rajapinta on RESTful-pohjainen ja siinä on tällä hetkellä kaksi päätepisteluokkaa:

  • Todentaminen

  • Studio

Aluekohtaisia perus-URL-osoitteita käytetään kaikkiin päätepisteisiin:

- Yhdysvallat: 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

Esimerkiksi https://api.bluebeam.com/publicapi/v1/sessions Yhdysvalloissa olisi https://api.bluebeamstudio.com.au/publicapi/v1/sessions Australiassa.

Todentaminen

Joitakin yleisiä muistiinpanoja todennuksen käsittelystä:

  • Todennus OAuth 2.0:lla

    • Kaikki API-kutsuja tehdään käyttäjän kontekstissa. OAuth-todennuksella käyttäjä myöntää sovelluksellesi luvan käyttää hänen tietojaan ja tehdä API-pyyntöjä hänen puolestaan.

  • Kaikkien pyyntöjen ja vastausten rungon on oltava JSON-muotoisia. Set Content-Type: application/json -otsikko kaikille pyynnöille, joilla on runko.

  • API-kutsujen on oltava HTTPS-protokollan yli.

  • Katso todennusoppaastamme ohjeet OAuth 2.0:n määrittämiseen sovelluksessasi.

Studio

Studio on Pilvi yhteistyöalustamme, jolla on suora yhteys lippulaivasovellukseemme: Bluebeam Revu. Studio-päätepisteemme Avaa viestintälinjoja saumattomaan integrointiin Studion ja järjestelmiesi välillä.

Yleisesti ottaen Studio API:n tarjoamia toimintoja voidaan pitää samoina toimintoina, jotka käyttäjä saisi Revun Studio-käyttöliittymän kautta.

Lisätietoja Studiosta on Studion usein kysyttyjen kysymysten sivulla.

Tässä menetelmässä käytetään esimerkkinä Postmania, mutta tämän menetelmän suorittamiseen voidaan käyttää muitakin API-ohjelmistoja.

Voit saada käyttöoikeustunnuksen toimimalla seuraavasti:

Tämä toimenpide edellyttää tietoja todennusoppaasta.

  1. Luo Bluebeam-tili ja pyydä käyttöoikeutta Bluebeam Developer Portal, jos sinulla ei vielä ole sellaista.

  2. Siirry osoitteeseen developers.bluebeam.fi ja kirjaudu sisään.

  3. Pyydä käyttöoikeutta ja luo asiakastunnus.

    1. Siirry kohtaan Omat sovellukset ja napsauta Pyydä käyttöoikeutta.

    2. Täytä Pyydä käyttöoikeutta -lomake (katso alla oleva kuvakaappaus). Valitse omaan alueeseesi liittyvä Bluebeam API -instanssi.

      Bluebeam Developer API on yhdysvaltalainen palvelin.

      3. Bluebeam API tukee vain seuraavia myöntämistyypin valintoja:
      • Käyttöoikeuksien tarkistuskoodi
      • Päivitystunnus

    3. Uudelleenohjauksen URI: käytä https://oauth.pstmn.io/v1/callback

      Tämä URI on tarkoitettu erityisesti Postmanin kutsujen tekemiseen. Vaihtoehtoiset API-työkalut tai sovelluksesi tarvitsevat eri URI:n.

    4. Lähetä lomake valitsemalla Pyyntö .

      5. Hyväksyntäsähköposti
      Kun Valitse, saat MuleSoft-merkkisen sähköpostin, jonka aihe on "Hakemuksen rekisteröinti hyväksytty" – Ohita. Se on toinen ei-toivottu sivuvaikutus, kun käytät valmiiksi asennettua ratkaisuamme.

  4. Hanki tunnistetiedot. Nyt sinun pitäisi nähdä juuri rekisteröity sovelluksesi luettelossa (jos et näe sitä, päivitä selain). Saat tunnistetietosi viemällä hiiren osoittimen avaimen päälle.


  5. Hanki käyttöoikeustunnus Postmanin kautta.

    1. Käytä Postmania heidän työpöytäsovelluksensa tai selaimensa kautta ja luo ilmainen tili.

    2. Tässä on skripti, jonka voit tuoda Postmaniin. Tämä skripti on kokoelma kaikkia käytettävissä olevia Bluebeam API -kutsuja. Siirry Postmanissa kohtaan Tiedosto > Tuo ja pudota komentosarja sisään.

    3. Saadaksesi access_token Postmanissa, Valitse Bluebeam API (Script xxx) -kokoelma.

    4. Määritä uusi tunnus Postmanissa valitsemalla Valtuutus-sarkain.

      Lisätietoja todennuksesta löytyy Todennusoppaasta. Todennusopas viittaa pyyntöparametreihin, joita kutsutaan Postmanissa muuttujiksi.
      Voit joko määrittää Postmanissa ympäristön muuttujien luomiseksi valtuutusta varten tai täyttää manuaalisesti Closedvaaditut arvot.

      Postmanin pakolliset asetukset ja arvot:

      • Todennustyyppi: täytyy olla OAuth 2.0

      • Myöntämistyyppi: valtuutuskoodi

      • Tunnuksen nimi: koodi

      • Myöntämistyyppi: valtuutuskoodi

      • Valtuuttaminen selaimessa täytyy olla käytössä.

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

      • Käyttötunnuksen URL-osoite: https://api.bluebeam.com/oauth2/token

      • Asiakastunnus: sovelluksen rekisteröintiprosessin aikana saatu asiakastunnus

      • Asiakassalasana: sovelluksen rekisteröintiprosessin aikana vastaanotettu asiakassalasana

      • Laajuus: Studio-päätepisteiden laajuudet; vähimmäisvaatimus on offline_access

      • Tila: tila

      • Asiakkaan todennus: lähetä asiakkaan tunnistetiedot viestirungossa

    5. Selaa alas ja napsauta Hanki uusi käyttöoikeustunnus.

    6. Kirjaudu sisään BBID-tunnuksellasi ja napsauta Salli käyttöoikeus , kun sinua pyydetään. Saat käyttöösi tunnuksen, jota voit käyttää Postmanissa, API-dokumentaatiossamme tai omassa koodissasi.

Tunnuksen vanheneminen
Tunnukset vanhenevat tunnin kuluttua, joten jos kutsusi lakkaavat toimimasta, suorita prosessi uudelleen saadaksesi uuden tunnuksen. Jos haluat määrittää OAuthin käyttämään Refresh-tokeneja, katso todennusoppaamme .

Tässä on vaiheittainen prosessi olemassa olevan integraation siirtämiseksi uudelle alustallemme.

  1. Luo BBID-tili, jos sinulla ei vielä ole sellaista.

  2. Siirry osoitteeseen developers.bluebeam.fi ja kirjaudu sisään.

  3. Rekisteröi uusi sovellus.

    1. Siirry kohtaan Omat sovellukset ja valitse Pyydä käyttöoikeutta.

    2. Täytä Pyydä käyttöoikeutta -lomake (katso alla oleva kuvakaappaus). Valitse omaan alueeseesi liittyvä Bluebeam API -instanssi.

      Muistiinpano apurahan tyypistä:

      Valitse vain seuraavien kohtien vieressä olevat ruudut:

      • Käyttöoikeuksien tarkistuskoodi
      • Päivitä tunnus

    3. Lähetä lomake valitsemalla Pyyntö .

  4. Hanki tunnistetiedot. Nyt sinun pitäisi nähdä juuri rekisteröity sovelluksesi luettelossa. Saat tunnistetietosi viemällä hiiren osoittimen avaimen päälle.


  5. Päivitä olemassa oleva integraatiosi alla luetelluilla uusilla API-reiteillä valtuutusta ja Studio-päätepisteitä varten.

    Yhdysvaltojen palvelimet

    Ympäristö

    Alkuperäinen perusreitti

    Uusi perusreitti

    Valtuutus – Tuotanto (USA)

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

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

    Valtuutus – Tuotanto (USA)

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

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

    Studio – Tuotanto (USA)

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

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

  6. Missä tahansa, missä vanha asiakastunnus ja asiakassalaisuus on määritetty integraatiossasi, korvaa ne uudella asiakastunnuksella ja -salaisuudella.

  7. Lisää API-kutsuihisi otsikko nimeltä "client_id", jossa on uuden asiakastunnuksesi arvo. Tämä vaaditaan kaikille uudelle alustalle tuleville pyynnöille.

    Muistiinpano
    Työskentelemme edelleen virheilmoitusten tarkentamisen ja merkityksellisyyden parantamiseksi, mutta jos lähetät pyyntösi ilman "client_id" -otsikkoa, näet tällä välin tällaisen virheilmoituksen:

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

  8. Uusi alustamme käsittelee todennuksen hieman eri tavalla kuin vanha alustamme, joten suosittelemme tutustumaan uuteen todennusoppaaseemme . Kaksi huomionarvoista muutosta:

    • Olemme esitelleet offline_access -vaikutusalueen päivitystunnuksille (katso vaihe 1 todennusoppaassa ).

    • Tunnistepäätepistevastauksemme ovat muuttuneet (katso esimerkkivastaukset todennusoppaasta ).

  9. Jos kaikki on määritetty oikein, sinun pitäisi saada vastaus, joka on identtinen edellisen Studio API:n vastauksen kanssa kaikille Studion päätepisteille.
    Jos esimerkiksi pyysit luetteloa Studio-projekteista, vastauksesi teksti näyttäisi suunnilleen tältä:

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

  10. Testaa sovellustasi ja kerro meille, jos kohtaat ongelmia.

 

Katso myös:


Resurssit

Revu 21

Developer Portal

Developer Portal

Tämä sivu on oppaasi uuteen Developer Portaliimme.