Todennusopas

Ensimmäinen vaihe on pyytää käyttäjän valtuutusta sovelluksellesi. Ohjaat käyttäjän valtuutuspäätepisteeseen, jossa häntä pyydetään kirjautumaan sisään Studio-tunnuksillaan ja myöntämään käyttöoikeudet sovelluksellesi. Voit tehdä tämän tekemällä GET pyynnön valtuutuspäätepisteeseen seuraavilla parametreilla.

Valtuutuspäätepiste

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

Pyyntöparametrit

Parametrit on välitettävä kyselymerkkijonossa.

Studio-päätepisteiden laajuusalueet

Päivitä tokeneita
Muista pyytää 'offline_access'-laajuus pyynnössäsi saadaksesi refresh_tokenin takaisin. Katso lisätietoja refresh_tokeneista alla olevasta vaiheesta 4.

Esimerkkipyyntö

GET https://api.bluebeam.com/oauth2/authorize?response_type=code&client_id=b5f9fc7c-60dd-469f-a21e-3f4a7ceb874b&redirect_uri=http://myserver.com&scope=full_prime offline_access jobs&state=myteststate

Käyttäjäkokemus

Käyttäjät ohjataan Bluebeam-kirjautumissivulle.

Kirjautumisen jälkeen käyttäjä voi Valitse Salli käyttöoikeus myöntääkseen sovelluksellesi pääsyn tietoihinsa.

Jos käyttäjä myöntää käyttöoikeuden sovellukseesi valitsemalla Salli käyttöoikeus, saat takaisinkutsun alkuperäisessä pyynnössäsi redirect_uri määritteen määrittämään URL-osoitteeseen. Jos takaisinkutsu onnistuu, se sisältää code , joka sinun on vaihdettava access_token. Varmista, että vastauksessa ilmoitettu state vastaa alkuperäisessä pyynnössä ilmoitettua osavaltiota. Jos on tapahtunut virhe, saat uudelleenohjauksen, jossa on error .

Vastausparametrit

Parametrit vastaanotetaan osana kyselymerkkijonoa.

Esimerkkivastaus

https://www.myserver.com/?code=acf3cabd-08c1-44db-88a9-4f785ec7c6ec&state=myteststate

Valtuutuskoodi on voimassa vain 5 minuuttia. Katso koodien ja tunnusten kestojen luettelo kohdasta Tunnuksen vanheneminen .

Nyt kun olet vastaanottanut code, seuraava vaihe on vaihtaa se Bluebeamin access_token. Voit tehdä tämän tekemällä POST pyynnön Token-päätepisteeseen alla olevilla parametreilla.

Tunnuspäätepiste

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

Pyyntöparametrit

Parametrien on oltava muotokoodattuja.

cURL-esimerkki

curl [https://api.bluebeam.com/oauth2/token](https://api.bluebeam.com/oauth2/token) \
-d grant_type=authorization_code \
-d code={code returned from previous step} \
-d redirect_uri={your redirect_uri} \
-d client_id={your client_id} \
-d client_secret={your client_secret} \
-d scope= offline_access {your requested scopes} \
-X POST

Esimerkkivastaus

{
  "token_type":"Bearer",
  "expires_in":3600,
  "access_token":"eyJraWQiOiIybEczWnV2Q1pHRDFQX0FYclk4U0YyVVdmU2x3WHFpNWxZcUFzaHc4M05rIiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULjJ0Ml9nQWtxc2RvcDFWcWR1ajdLVUZwbXdNT1ZvU1VxcmZWVm5TOUZuMU0iLCJpc3MiOiJodHRwczovL3NpZ25pbi5ibHVlYmVhbS5jb20vb2F1dGgyL2F1c2JlcGh2azBlYkk3T09UNHg3IiwiYXVkIjoiYXBpOi8vYmItYWNtIiwiaWF0IjoxNzA4OTcwMzM2LCJleHAiOjE3MDg5NzM5MzYsImNpZCI6IjBvYWc2aGFjYWhnRUtqM0loNHg3IiwidWlkIjoiMDB1YngyeThtMDlwelVKRms0eDciLCJzY3AiOlsiZnVsbF9wcmltZSJdLCJhdXRoX3RpbWUiOjE3MDg5NzAzMTcsInN1YiI6InRvcnlhZGFtc0BwbS5tZSIsImJiaWQiOiJkNzE3MGZmYy03ZjlmLTQxZjYtOTY2ZS0xOTg1NTJlNzQwOTAifQ.S8m-cIfq8m19GtJ67skC8WM4bMWvJbAAr74A7g3HrUmH66M1_MN4MaDWjgcYjNFOI1zWsiZ5qm1HODLYY92lgUfzGuiYnkvpiJEKBtIUzLec2E2uEGE5HuW6FbyiX_SdGnSKeHlTr_FfiWGcpTYF816rI6q72kFm2J_3pKA-z_6REkNhI7qouRDRIHqT88tOE9KcjrF8_HsRAuixYAOlcGoVq3rvupvNVVaekoLyGiGWovXdJ-Wrx-1pKo0r7px2_Y8ew9OWEgYCX0u8pQvvPB6HAfF8dNCGTz_jFw9MbItu70rIniDoycILZKNxOcdKTLsCK7AC5doBcg9dV0OrHQ",
  "scope":"full_user offline_access",
  "refresh_token":"f5Mj16b7eVXwlY3Axc7TH2oEG_FPV1BrY05ht0uin6B"
}

Vastausparametrit

Kun olet vastaanottanut access_token, voit käyttää sitä API:n käyttämiseen. Jos haluat käyttää access_token, lisää se Authorization-otsikkoon:

Authorization: Bearer {a valid access_token}

Kun lähetät valtuutusotsikkoa, varmista, että "Bearer"-kohdan "B" on isolla alkukirjaimella. Jos "Bearer" ei ole isolla alkukirjaimella, saat virheen.

Käyttöoikeustunnukset

An access_token on varsinainen merkkijono, jonka avulla voit tehdä pyyntöjä käyttäjän puolesta. Jokaisen Bluebeam API:lle tehdyn pyynnön on sisällettävä kelvollinen access_token.

Jokainen access_token on voimassa 60 minuuttia. Kun access_token vanhenee, uusi access_token voidaan myöntää ilman, että käyttäjän tarvitsee kirjautua uudelleen sisään, vaihtamalla kelvollinen refresh_token.

Päivitä tokeneita

Päivitystunnusten tarkoitus
Päivitystunnukset ovat kätevä ja turvallinen tapa tehdä todennettuja pyyntöjä Bluebeam API:lle ilman, että käyttäjän tarvitsee kirjautua sisään jokaista pyyntöä varten.
Päivitystunnukset vaihdetaan aina 1) tunnin voimassa olevaan access_tokeniin ja 2) uuteen päivitystunnukseen, joka pysyy voimassa niin kauan kuin sitä käytetään vähintään kerran 7 päivässä.
Teoriassa, kun käyttäjä myöntää manuaalisesti käyttöoikeuden vaiheessa 1, voit jatkuvasti vaihtaa voimassa olevia päivitystunnuksia käyttöoikeustunnuksiin, jotta käyttäjän ei koskaan tarvitse valtuuttaa manuaalisesti uudelleen, edellyttäen, että vaihdat päivitystunnuksia vähintään kerran 7 päivässä.

Saadaksesi ensimmäisen refresh_token tunnuksesi, suosittelemme pyytämään offline_access laajuusarvoa vaiheessa 1, jotta saat myös refresh_token.

Vaihda refresh_token uuteen access_token 3600 sekunnin kuluessa viimeisen access_token hankkimisesta. Kun vaihdat refresh_token access_token, sinulle myönnetään uusi refresh_token .

Toisin kuin access_token, joka vanhenee tunnin kuluttua, refresh_token pysyy voimassa toistaiseksi, kunhan sitä käytetään vähintään kerran seitsemässä päivässä. refresh_token mitätöityy, jos sitä ei käytetä 7 päivän kuluessa.

Säilytä refresh_token salattuna ja turvallisessa paikassa. Jos refresh_token katoaa tai vanhenee, sinun on pyydettävä käyttäjiä valtuuttamaan uudelleen OAuth-työnkulun alusta alkaen.

Vaihtaaksesi refresh_token uuteen access_token ja refresh_token, tee POST pyyntö Token-päätepisteeseen:

Tunnuspäätepiste

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

Pyyntöparametrit

Parametrien on oltava muotokoodattuja.

cURL-esimerkki

curl [https://api.bluebeam.com/oauth2/token](https://api.bluebeam.com/oauth2/token) \
-H Content-Type: application/x-www-form-urlencoded \
-H Authorization: Basic {base64 encoded string of client_id:client_secret} \ 
-d grant_type=refresh_token \
-d refresh_token={your refresh_token} \
-X POST

Päivitystunnusten peruuttaminen
Päivitystunnukset voidaan peruuttaa. Kun refresh_token peruutetaan, käyttäjien on valtuutettava se uudelleen nykyisen access_tokenin vanhenemisen jälkeen.