Studio-istunto-opas

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.

Ajattele Studio-istuntoa digitaalisena kokoushuoneena, jossa PDF-piirustuksia voidaan merkitä joko samanaikaisesti tai asynkronisesti. Tämä opas kattaa Studio-istunnon yleisen elinkaaren ja sisältää koodiesimerkkejä. Lisätietoja Studiosta ja Studio-istunnoista yleensä on Studion usein kysytyt kysymykset -sivullamme.

Voit seurata tätä opasta ja kokeilla monia API-dokumentaatiomme Studio-osiossa olevia ohjeita. Katso ohjeet kelvollisen käyttöoikeustunnuksen hankkimiseen Bluebeam Developer Portalin käytön aloittamista käsittelevästä oppaastamme.

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.

Studiosessioiden elinkaari

Studio-istunnon elinkaari voidaan jakaa neljään osaan:

Alustus – Avaa "digitaalisen kokoushuoneen"
Lisää PDF-tiedostoja Istuntoon katselua ja merkintöjä varten
Lisää käyttäjiä Istuntoon, jotta he voivat tarkastella ja merkitä
Viimeistely – Sulkee istunnon ja palauttaa merkityt PDF-tiedostot alkuperäiseen järjestelmään.

1. Istunto alustaa

Studio-istunnon elinkaaren ensimmäinen vaihe on sen luominen. Aloita tekemällä POST komento Sessions-päätepisteeseen seuraavilla parametreilla.

Päätepiste

Kopioi

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

Muista sisällyttää client_id pyyntösi otsikkoon.

Pyyntöparametrit

Nimi	Kuvaus	Arvon tyyppi / Mahdolliset arvot
`Nimi`	Istunnon nimi	String
`Notification`	`Kyllä`: Käyttäjä tilaa sähköposti-ilmoitukset tämän Istunnon muutoksista. `false`: Nykyinen käyttäjä ei tilaa sähköposti-ilmoituksia tämän istunnon muutoksista.	Totuusarvo
`Restricted`	`Kyllä`: Rajoittaa Istunto vain kutsuttuihin tai lisättyihin sähköpostiosoitteisiin. `Ei`: Jättää Istunnon Avaa kaikille, joilla on 9-numeroinen Istunto ID.	Totuusarvo
`SessionEndDate`	Kun tämä päivämäärä koittaa, kaikki osallistujat isäntää lukuun ottamatta poistetaan Istunnosta.	Must be formatted in UTC format.
`DefaultPermissions`	Tämä käyttöoikeusjoukko Käytä kaikkia tähän Istuntoon lisättyjä käyttäjiä paitsi isäntää (nykyistä käyttäjää). Isäntä saa Täydet oikeudet.	Määritä alla käyttöoikeuksien tyypit ja itse käyttöoikeudet.

Luvallista	Kuvaus	Arvon tyyppi / Mahdolliset arvot
`Type`	Luvan tyyppi	`SaveCopy` – Salli osallistujien Tallenna nimellä. `PrintCopy` – Salli osallistujien tulostaa Istuntoon sisältyviä PDF-tiedostoja. `Markup` – Salli osallistujien tehdä merkintöjä. `AddDocuments` – Salli osallistujien lisätä uusia asiakirjoja Istuntoon. `FullControl` – Anna osallistujille istunnon ylläpitäjän oikeudet. `MarkupAlert` – Salli osallistujien lähettää ja vastaanottaa merkintöjä istunnon aikana.
`Allow`	Käyttöoikeustila	Salli, Kieltäydy, Oletusarvo

Luvallista

Kuvaus

Arvon tyyppi / Mahdolliset arvot

Type

Luvan tyyppi

SaveCopy – Salli osallistujien Tallenna nimellä.

PrintCopy – Salli osallistujien tulostaa Istuntoon sisältyviä PDF-tiedostoja.

Markup – Salli osallistujien tehdä merkintöjä.

AddDocuments – Salli osallistujien lisätä uusia asiakirjoja Istuntoon.

FullControl – Anna osallistujille istunnon ylläpitäjän oikeudet.

MarkupAlert – Salli osallistujien lähettää ja vastaanottaa merkintöjä istunnon aikana.

Allow

Käyttöoikeustila

Salli, Kieltäydy, Oletusarvo

Istunnon päättymispäivä
Istunnon päättymispäivämäärät eivät ole pakollisia, mutta jos istunnon päättymispäivä valitaan, istunnon osallistujille ilmoitetaan siitä sähköpostitse 7 päivää, 2 päivää ja 24 tuntia ennen päättymispäivää.

cURL-esimerkki

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions](https://api.bluebeam.com/publicapi/v1/sessions) \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client_id]" \
-d '{

    "Name":"Pied Piper Acquisition Review",

    "Notification": true,

    "Restricted": true,

    "SessionEndDate": "2016-08-17T21:09:07.5174221Z",

    "DefaultPermissions":[  
      {  
        "Type":"SaveCopy",  
        "Allow":"Allow"  
      },  
      {  
        "Type":"PrintCopy",  
        "Allow":"Allow"  
      },  
      {  
        "Type":"Markup",  
        "Allow":"Allow"  
      },  
      {  
        "Type":"MarkupAlert",  
        "Allow":"Allow"  
      },  
      {  
        "Type":"AddDocuments",  
        "Allow":"Deny"  
      }  
    ]
}' \
-X POST

Käyttöoikeudet
Nykyiset Studio-käyttäjät ovat usein tottuneet tiettyihin oletusasetuksiin käyttöoikeuksissa. On aina hyvä joko tarkistaa oletuskäyttöoikeudet tai antaa käyttäjien valita omat käyttöoikeutensa. Kun käyttöoikeuksia asetetaan Bluebeam-rajapintaa käyttäen, oletusarvo on 'Estä'.

Vastauksen runko

Kopioi

{
    "$id": "1",
    "Id": "123-456-789"
}

2. Lisää PDF-tiedostoja

Seuraava vaihe on PDF-tiedostojen lisääminen. Tiedostojen lisääminen on kolmivaiheinen prosessi:

Luo tiedostolle metatietolohko Bluebeam API:n kautta.
Lataa tiedosto suoraan AWS:ään
Vahvista lataus Bluebeam API:n kautta

Muistiinpano: Studio-istunnot eivät tue PDF/A-tiedostoja.
Koska PDF/A on arkistointimuoto, sitä ei voi muokata ja vaihe 4 alla epäonnistuu.

a. Luo metatietolohko

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files

Parametrit

Nimi	Kuvaus	Arvon tyyppi / Mahdolliset arvot
`Nimi`	Tiedoston nimi	Merkkijono, joka päättyy ".pdf":ään
`Source`	Lähdepolku; tämä voi auttaa sinua tunnistamaan tiedoston alkuperän myöhemmin prosessissa	String
`Size`	Tiedoston koko; jätä tyhjäksi, jotta palvelin voi laskea sen	Kokonaisluku
`CRC`	Jätä tyhjäksi, jotta palvelin voi laskea	String

cURL-esimerkki

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files) \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client_id]" \
-d '{  
      "Name":"Pied_Piper_Acquisition.pdf",  
      "Source":"[https://portfolio.raviga.com/primarybets/piedpiper/legaldocs/Pied_Piper_Acquisition.pdf](https://portfolio.raviga.com/primarybets/piedpiper/legaldocs/Pied_Piper_Acquisition.pdf)"
    }' \
-X POST

Esimerkkivastaus

Kopioi

{
  "Id": 1234567
  "UploadUrl":"{upload file to this URL}"
  "UploadContentType":"Application/PDF"
}

Latausikkuna
Lataus-URL-osoite on voimassa 10 minuuttia latauksen aloittamiseksi.

c. Vahvista lataus

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files/{id}/confirm-upload

cURL-esimerkki

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/confirm-upload](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/confirm-upload) \
-H "Authorization: Bearer {valid access_token}" \
-H "client_id: [your client id]" \
-X POST

Vastaus

Jos onnistut, saat vastauksen 204 . Virheiden varalta katso yleisiä HTML-vastauskoodeja todennusoppaamme alaosasta.

3. Lisää käyttäjiä

Nyt kun sinulla on Istunto, jossa on PDF-tiedostoja, on aika lisätä käyttäjiä Istuntoon. Istunnon aloittajasta (nykyisestä käyttäjästä) tulee automaattisesti Istunnon isäntä ja hänet lisätään automaattisesti Istunnon käyttäjiin. Käyttäjiä voidaan aina lisätä istunnon ollessa aktiivinen. Käyttäjien lisäämiseen on kaksi tapaa:

Menetelmä A: Kutsu käyttäjä

Tämä menetelmä on paras sellaisten käyttäjien kutsumiseen, joilla ei ehkä vielä ole Studio-tiliä. Kutsutulle lähetetään sähköpostiviesti, jossa annetaan mahdollisuus Luo ilmainen Studio-tili.

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/invite

Parametrit

Nimi	Kuvaus
`Email`	Sähköpostiosoite, johon kutsu lähetetään

Esimerkki

Kopioi

cURL https://api.bluebeam.com/publicapi/v1/sessions/{session}/invite \
-H "Authorization: Bearer {token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: {client_id}" \
-d '{  
      "Sähköposti":"gavin.belson@hooli.com",  
      "Viesti":"Osallistu tähän istuntoon tarkastellaksesi asiakirjoja, jotka koskevat Pied Piper -yrityskauppaa."
    }' \
-X POST

Vastaus

Jos onnistut, saat vastauksen 204 . Virheiden varalta katso yleisiä HTML-vastauskoodeja todennusoppaamme alaosasta.

TAI

Menetelmä B: Käyttäjän lisääminen

Tämä menetelmä on paras, jos tiedät, että sähköpostiosoite on jo liitetty Studio-tiliin ja haluat sen lisättävän Studio-istuntoon ilman erillistä suostumusta. Jos käyttäjällä ei ole tiliä tai hän ei ole varma, onko hänellä tiliä, käytä menetelmää A: Kutsu käyttäjä. Menetelmää B: Lisää käyttäjä käytettäessä käyttäjä lisätään Studio-istunnon osallistujiin, ja Studio-istunto näkyy heidän Osallistuneet istunnot -kohdassa Revu-käyttöliittymän Studio-sarkaimella.

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/users

Parametrit

Nimi	Kuvaus
`Email`	Tunnetun Studio-tilin sähköpostiosoite
`SendEmail`	Boolean; Kyllä: lähetä sähköpostia kutsutulle, Ei: älä lähetä sähköposti-ilmoitusta kutsutulle

Esimerkki

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/users](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/users)
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-d '{  
      "Sähköposti": "peter.gregory@raviga.com",
      "SendEmail": true,
      "Viesti": "Kuten pyydetty, tässä on istunto Pied Piper -yrityskaupan asiakirjojen tarkastelua varten."
    }' \
-X POST

Vastaus

Jos onnistut, saat vastauksen 204 . Virheiden varalta katso yleisiä HTML-vastauskoodeja todennusoppaamme alaosasta.

Esimerkki Istunto-kutsusta sähköpostitse

4. Viimeistele istunto

Istunnon lopettamiseksi (yleensä se tehdään sen jälkeen, kun osallistujat ovat tehneet merkintönsä tai istunnon vanhenemispäivämäärä on saavutettu) sen tila on muutettava, sen tiedostot on käsiteltävä ja itse istunto on hävitettävä asianmukaisesti.

a. Set tilaksi Viimeistellään

Istunnon tilan asettaminen viimeistelyvaiheessa poistaa istunnosta kaikki käyttäjät paitsi isännän. Tämä tehdään, jotta Istunto-tiedostoihin ei tehdä enää muutoksia niiden lataamisen jälkeen.

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{id}

Esimerkki

Kopioi

cURL https://api.bluebeam.com/publicapi/v1/sessions/123-456-789 \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-d '{"Status": "Finalizing"}' \
-X PUT

b. Lataa merkityt Istunto-tiedostot

Merkittyjen Istunto-tiedostojen lataaminen on kaksiosainen prosessi. Noudata alla olevia ohjeita kullekin istunnon tiedostolle.

i. Luo Pikakuva

Istunnon aikana PDF-tiedostot ja merkinnät tallennetaan erikseen. Pikakuva yhdistää PDF-sisällön ja merkintäkerroksen yhdeksi PDF-tiedostoksi, jotta Merkinnät ovat nähtävissä PDF-tiedostossa Studio-istunnon ulkopuolella.

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files/{id}/snapshot

Esimerkki

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/snapshot](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/snapshot) \
-H "Authorization: Bearer {valid access_token}" \
-H "client_id: [your client id]" \

ii. Tarkista Pikakuvan tila ja lataa se, jos se on valmis.

Tee GET -pyyntö Pikakuva-päätepisteelle, kunnes Status on joko Complete tai Error.

Jos Error: Sisällytämme virheilmoituksen, joka voidaan näyttää käyttäjälle.
Jos Complete: Lataa Pikakuva DownloadUrl osoitteen avulla

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files/{id}/snapshot

Esimerkki

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/)
-H "Authorization: Bearer {valid access_token}" \
-H "client_id: [your client id]" \
-X GET

Vastauksen runko

Kopioi

{
    "Status": "Complete",
    "StatusTime": "{The last time the Status was changed}",
    "LastSnapshotTime": "{Time of last successful Snapshot}",
    "DownloadUrl": "{A download URL for the last successful Snapshot}"
}

Tila-asetukset

Tila	Kuvaus
`NoSnapshot`	Kun tiedostosta ei ole koskaan kutsuttu Pikakuvaa
`Requested`	Pikakuvatyö ei ole vielä alkanut, mutta olemme vastaanottaneet pyynnön.
`InProgress`	Tilannevedostyö on käynnissä
`Complete`	Pikakuva-työ on valmis ja se voidaan ladata `DownloadUrl`osoitteesta
`Error`	Tilannevedostyö epäonnistui. Tilaan sisältyy virheilmoitus.

c. Sulje istunto

Nyt kun sinulla on merkityt PDF-tiedostot, voit hävittää Istunnon lähettämällä DELETE pyynnön istuntotunnuksen päätepisteeseen.

Päätepiste

Kopioi

https://api.bluebeam.com/publicapi/v1/sessions/{id}

Esimerkki istunnon päättämisestä

Kopioi

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789) \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-X DELETE

Johtopäätös

Tiedoston palauttaminen alkuperäiseen sijaintiinsa ja istunnon arkistointi päättää tyypillisen Studio-istunnon elinkaaren. Vaikka Studio-istuntojen kanssa voi työskennellä monella eri tavalla, toivomme, että tämä läpikäynti antoi sinulle hyvän käsityksen perusasioista.

Katso myös:

Resurssit

Revu 21

Developer Portal

Tämä Developer Portal -opas käsittelee Studio-istunnon yleistä elinkaarta ja sisältää koodiesimerkkejä.