Aloita Bluebeam Developer Portalissa

Bluebeam Developer Portal on rakennettu uudelleen tarjoamaan kehittäjille nopeamman ja selkeämmän itsepalvelukokemuksen. Tässä oppaassa käydään läpi uusi Sandbox-ympäristö, virtaviivaistettu sovelluksen rekisteröintivirta, selaimen sisäinen API-testaus ja uusi Production-hyväksyntäprosessi.

Alkuun pääsemiseksi tutustu Yleiskatsaukseen: Näin pääset alkuun.

Valitse polkusi:

Uudet ominaisuudet

  • Automatisoitu käyttöönotto: Käyttöoikeus myönnetään välittömästi kirjautumisen yhteydessä tilauksesi perusteella.

  • Hiekkalaatikko edellä -työnkulku: Kaikki sovellukset alkavat Hiekkalaatikosta, mikä antaa sinulle turvallisen tilan rakentaa ja testata ennen käyttöönottoa.

  • Yksinkertaistettu sovelluksen luonti: Uusi "Luo sovellus" -lomake näyttää vain kentät, jotka koskevat Bluebeam-integraatioita.

  • Selaimen sisäinen API-testaus: Uusi ”Testaa pyyntö” -toiminto antaa sinun suorittaa kutsuja suoraan dokumenteissa, useilla kielillä.

  • Päätepistehaku: Haku kaikista API-päätepisteistä ja parametreista vierittämättä.

  • Merkinnät API-päätepisteet: Nämä päätepisteet ovat nyt poistuneet Beta-vaiheesta ja kaikkien kehittäjien käytettävissä.

Aloituksen yleiskatsaus

Vaihe 1: kirjaudu sisään
Siirry osoitteeseen developers.bluebeam.com ja kirjaudu sisään BBID-tunnuksellasi. Pääsy myönnetään automaattisesti aktiivisella Core-, Complete- tai Max -tilauspaketilla. Siirry vaiheeseen 1 ➝

Vaihe 2: Rakenna ja testaa Sandboxissa
Käytä Sandbox-tunnuksiasi rakentaa ja testaamiseen ennen kuin integraatiosi saavuttaa loppukäyttäjä. Siirry vaiheeseen 2 ➝

Vaihe 3: luo sovellus
Siirry Omat sovellukset -kohtaan ja valitse Luo sovellus. Anna sovelluksen nimi, kuvaus, alue ja uudelleenohjauksen URI(t). Siirry vaiheeseen 3 ➝

Vaihe 4: Tarkastele Omat sovellukset -hallintapaneelia
Omat sovellukset -taulukkoon on lisätty Sarakkeet, jotta näet sovelluksen tärkeimmät tiedot yhdellä silmäyksellä. Siirry vaiheeseen 4 ➝

Vaihe 5: tarkista API-dokumentaatio ja testipyyntö
Käytä testipyyntöä API-dokumentaatiossa päätepisteen toiminnan varmistamiseksi selaimessa. Siirry vaiheeseen 5

Vaihe 6: pyydä tuotantohyväksyntä
Valitse sovelluksen tiedot -sivulta Pyydä tuotantohyväksyntää (Request Production Approval) ja lähetä tuotantohyväksyntälomake. Siirry vaiheeseen 6 ➝

Vaihe 7: Siirry julkaisuun
Bluebeam-integraatiotiimi tarkistaa ja seuraa. Kun se on hyväksytty, sovelluksesi siirretään tuotantoon.

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:

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.

Voit saada käyttöoikeustunnuksen toimimalla seuraavasti:

Tämä toimenpide edellyttää tietoja todennusoppaasta.

Kun kirjaudut sisään BBID -tunnuksellasi Okta-portaalin kautta, portaali vahvistaa välittömästi kelpoisuutesi. Käyttöönoton manuaalista pyyntöä tai sähköpostia kumppanuustiimille ei tarvita, ellet ole ohjelmistokehittäjä ja/tai kumppani.

Tilausvaatimukset

Kirjautumisen yhteydessä portaali tarkistaa, että tilisi täyttää kaikki kolme kriteeriä:

  • Voimassa oleva BBID -tili

  • Aktiivinen Core-, Complete- tai Max -tilauspaketti

    • Basics-tilauspaketti ei sovellu: Basics-tilaajat eivät voi käyttää Developer Portal, koska he eivät voi luoda projekteja ja istuntoja, jotka ovat kriittisiä toimintoja useimmille integroinneille. Päivitä Core-, Complete- tai Max-pakettiin saadaksesi käyttöoikeuden.

    • Ohjelmistokehittäjät ja kumppanit: Jos tarvitset erityisen NFR-käyttöoikeuden Bluebeam Partnershipsin kautta, sinun on pyydettävä pääsyä Bluebeam Developer Portal.

  • Kelvollinen alue: US, AU, DE, UK ja SE

Kaikki uudet sovellukset luodaan Sandbox-ympäristöön oletusarvoisesti. Sandbox antaa sinulle oman tilan rakentaa ja testata integraatiosi turvallisesti ennen kuin se saavuttaa loppukäyttäjät.

  • Sandbox-tunnukset pysyvät muuttumattomina, kun sovelluksesi siirretään tuotantoon.

  • Kun siirrytään tuotantoon, nopeusrajoitukset mukautuvat tukemaan todellisen käytön rajoituksia.

  • Kun sovelluksesi on Sandbox-tilassa, vain sovelluksen omistava tili voi todentaa käyttäjänsä sovelluksen kautta. Muut käyttäjät voivat käyttää sovellusta sen jälkeen, kun se on siirretty tuotantoon.

  • Sovellukset pysyvät kehitysympäristössä, kunnes pyydät nimenomaisesti tuotantohyväksyntää (katso vaihe 6).

Sovelluksen luontiprosessi on suunniteltu uudelleen. Luo sovellus -lomake näyttää vain Bluebeam-integraatioiden kannalta merkitykselliset kentät.

Alusta ja alueet

  1. Siirry kohtaan Omat sovellukset ja valitse Luo sovellus.

  2. Valitse alueeseesi sopiva API-instanssi sovellusta luotaessa:


Rekisteröintilomakkeen kentät

  1. Täytä rekisteröintilomakkeen kentät:

    • Sovelluksen nimi: Merkkejä enintään 90.

    • Kuvaus: Kirjoita enintään 300 merkkiä.

    • Alue: Valitse alueesi Bluebeam API -instanssi.

    • Uudelleenohjaus-URL-osoite/osoitteet: Syötä pilkuilla eroteltuja arvoja tai paina Enter – portaali järjestää ne sivutettuun luetteloon.

    • Testaatko Postmanilla? Uudelleenohjauksen URI: Käytä https://oauth.pstmn.io/v1/callback. Tuotantosovelluksesi käyttää eri URI:a.

Todennusmuistiinpanot

  1. Bluebeam API tukee vain seuraavia myöntämistyypin valintoja:

    • Valtuutuskoodi: Kaikki API-kutsut käyttävät OAuth 2.0:aa; käyttäjät myöntävät sovelluksellesi luvan toimia puolestaan.

    • Päivitystunnus

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

  3. Valitse Luo sovellus lähettääksesi lomakkeen.
    Kun olet lähettänyt lomakkeen, saat MuleSoft-brändätyn sähköpostiviestin, jonka aiheenä on: "Application registration approved". Ole hyvä ja ohita sähköposti. Se on ei-toivottu sivuvaikutus, joka johtuu käyttövalmiin ratkaisumme käytöstä.

  4. Hae tunnistetiedot. Nyt sinun pitäisi nähdä juuri luomasi sovellus luettelossa (jos et näe sitä, päivitä selaimesi). Napsauta mitä tahansa sovellusrivillä, ja se avaa tietosivun, jossa voit tarkastella asiakastunnustasi ja asiakasohjelman salasanaa.

  5. Jos käytät Postmania testaamiseen, 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. Valitse Valtuutus -sarkain määrittääksesi uuden tunnuksen Postmanissa.

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

      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. Vieritä alareunaan ja valitse Hanki uusi käyttöoikeustunnus.
    6. Kirjaudu sisään BBID -tunnuksellasi ja valitse pyydettäessä Salli käyttöoikeus. Saat käyttöösi tunnuksen, jota voit käyttää Postmanissa, API-dokumentaatiossamme tai omassa koodissasi.
Tunnuksen vanheneminen
Tokenit vanhenevat 1 tunnin kuluttua, joten jos puhelusi lakkaavat toimimasta, käy prosessi läpi uudelleen saadaksesi uuden tokenin. Jos haluat määrittää OAuthin käyttämään päivitystokeneita, katso todennusoppaamme .

Omat sovellukset -taulukkoa on päivitetty lisäsarakkeilla, jotta näet tärkeät sovellustiedot yhdellä silmäyksellä.

  • Nimi: Luomasi sovelluksen nimi

  • Asiakastunnus: Ainutkertainen tunniste, jota käytetään kaikissa API-pyynnöissä

  • Ympäristö: Nykyinen tila (Sandbox, Odotustilassa tai Tuotanto)

  • Luontipäivä: Sovelluksen luomispäivämäärä

  • Alue: API-alue, johon sovelluksesi Luo

  • Toiminnot: Valitse muokataksesi, poistaaksesi, tarkastellaksesi tunnistetietoja tai pyytääksesi tuotantohyväksyntää

Taulukon alareunasta voit tarkastella edellisiä ja seuraavia sivuja, jos hallinnoit useita sovelluksia.

Hakupäätepisteet

Uuden Haku-hakupalkin avulla voit hakea kaikista päätepisteistä ja parametreista selaamatta koko viitettä. Kirjoita avainsana (esim. Istunto, Merkinnät) siirtyäksesi asiaankuuluvaan päätepisteeseen.

Testipyyntö

Jokainen API-päätepiste sisältää nyt Testaa pyyntö -painikkeen. Valitse se ja avaa selaimessa oleva Paneeli, jossa voit:

  • Täytä kyselyparametrit ja pyynnön rungot

  • Suorita reaaliaikaisia API-kutsuja suoraan ohjeista

  • Näytä koko vastaus suoraan

  • Vaihda ohjelmointikieliä (Python, cURL ja muita)

Nyt saatavilla: Merkinnät-sovellusliittymän päätepisteet ovat poistuneet betasta ja ovat kaikkien kehittäjien saatavilla. Lisäkäyttöoikeuksia ei tarvita.

Kun sovelluksesi on rakennettu ja testattu Sandboxissa, valitse Request Production Approval -painiketta sovelluksesi tietosivulta kohdassa My Apps. Tämä avaa esitäytetyn tuotantohyväksynnän pyyntölomakkeen. Kun lomake on valmis, vahvista vastuuvapauslausekkeen valintaruutu ja valitse Submit for Production Approval. Vahvista lopuksi lähetyksesi.

Lomakkeen lähettämisen jälkeen Integrations Partnerships -tiimi lähettää sinulle sähköpostitse päivityksen tilanteesta 5 arkipäivän kuluessa.

Sovelluksen tila lähetyksen jälkeen.

  • Sovelluksen tila muuttuu odottavaksi, kun hyväksyntäpyyntö on lähetetty.

  • Integration Partnerships -tiimi lähettää sinulle sähköpostitse jonkin seuraavista päivityksistä:

    • TUOTANTO – sovelluspyyntösi hyväksyttiin ja siirrettiin tuotantoon

    • ODOTTAA – Bluebeam tarvitsee lisätietoja ennen sovelluspyynnön hyväksymistä ja sen siirtämistä tuotantoon

    • SANDBOX – sovelluspyyntösi hylättiin tai peruutit lähetyksesi

  • Lopullisen hyväksynnän jälkeen sovelluksesi siirretään tuotantoon. Muut käyttäjät, joilla on asiakastunnuksesi ja salasanasi, voivat nyt tunnistautua sovelluksen kautta.

 

Katso myös: