Veiledning for Studio-sesjoner

Bluebeam Developer Portal, for integrasjonsutvikling, er kun tilgjengelig for aktive kunder, kanalpartnere og programvarepartnere i USA, Australia, Tyskland, Storbritannia og Sørøst-regionene.

Tenk på en Studio-økt som et digitalt konferanserom der PDF-tegninger kan merkes opp enten samtidig eller asynkront. Denne veiledningen dekker den generelle livssyklusen til en Studio-økt og inkluderer kodeeksempler. For å lære mer om Studio og Studio-økter generelt, kan du gå til siden vår for vanlige spørsmål om Studio.

Du kan følge denne veiledningen og prøve mange av oppfordringene i Studio-delen av API-dokumentasjonen vår. Se veiledningen vår for å komme i gang i Bluebeam Developer Portal for instruksjoner om hvordan du får et gyldig tilgangstoken.

Det finnes regionspesifikke basis-URL-er som gjelder for alle endepunkter:

For eksempel ville https://api.bluebeam.com/publicapi/v1/sessions i USA være https://api.bluebeamstudio.com.au/publicapi/v1/sessions i Australia.

Livssyklusen til Studio-økter

Livssyklusen til en Studio-økt kan deles inn i fire deler:

  1. Initialisering – Åpner det «digitale konferanserommet»

  2. Legg til PDF-filer i økten for visning og markering

  3. Legg til brukere i økten slik at de kan se og legge til merkinger

  4. Avslutning – Lukker økten og returnerer de markerte PDF-filene til det opprinnelige systemet

Den første fasen i en Studio-økts livssyklus er opprettelsen. For å begynne, lag en POST -kommando til Sessions-endepunktet med følgende parametere.

Endepunkt

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

Sørg for å inkludere client_id i overskriften på forespørselen din.

Forespørselsparametere

Navn

Beskrivelse

Verditype / Mulige verdier

Navn

Øktnavn

Streng

Notification

true: Nåværende bruker vil abonnere på e-postvarsler om endringer i denne økten.

false: Nåværende bruker vil ikke abonnere på e-postvarsler om endringer i denne økten.

Boolsk

Restricted

true: Begrenser økten til kun e-postadresser som er invitert eller lagt til.

false: Gjør økten åpen for alle som har den 9-sifrede økt-ID-en.

Boolsk

SessionEndDate

Når denne datoen er nådd, vil alle deltakere unntatt verten bli fjernet fra økten.

Must be formatted in UTC format.

DefaultPermissions

Dette tillatelsessettet gjelder for alle brukere som er lagt til i denne økten, bortsett fra verten (den gjeldende brukeren). Verten får full kontroll.

Definer typer tillatelser og selve tillatelsene nedenfor.

Tillatelse

Beskrivelse

Verditype / Mulige verdier

Type

Type tillatelse

SaveCopy – Tillat deltakerne å lagre som.

PrintCopy – La deltakerne skrive ut PDF-filer som er inkludert i økten.

Markup – La deltakerne legge inn markeringer.

AddDocuments – La deltakerne legge til nye dokumenter i økten.

FullControl – Gi deltakerne administratorrettigheter til økten.

MarkupAlert – Tillat deltakerne å sende og motta markeringsvarsler under økten.

Allow

Tillatelsesstatus

Tillat, Avslå, Standard

Sluttdato for økt
Sluttdatoer for økt er ikke påkrevd, men hvis en sluttdato for økten velges, vil deltakerne i økten bli varslet via e-post 7 dager, 2 dager og 24 timer før utløpsdatoen.

cURL-eksempel

Kopier 
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

Tillatelser
Nåværende Studio-brukere er ofte vant til spesifikke standardinnstillinger for tillatelser. Det er alltid lurt å enten sjekke hva standardtillatelsene skal være, eller la brukerne velge sine egne tillatelser. Når du bruker Bluebeam API til å angi tillatelser, er «Avslå» standardverdien.

Svartekst

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

Neste trinn er å legge til PDF-filene. Å legge til filer er en prosess i tre trinn:

  1. Opprett metadatablokken for filen via Bluebeam API

  2. Last opp filen direkte til AWS

  3. Bekreft opplasting via Bluebeam API

Merk: Studio-økter støtter ikke PDF/A-filer.
Fordi PDF/A er et arkivformat, tillater det ikke redigering, og det vil føre til at trinn 4 nedenfor mislykkes.

Endepunkt

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

Parametere

Navn

Beskrivelse

Verditype / Mulige verdier

Navn

Navn på fil

Streng som slutter på «.pdf»

Source

Kildesti; dette kan hjelpe deg med å identifisere hvor filen kom fra senere i prosessen

Streng

Size

Filstørrelse; la stå null slik at serveren kan beregne det

Heltall

CRC

Legg igjen null for at serveren skal kunne beregne

Streng

cURL-eksempel

Kopier 
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

Eksempelsvar

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

Opplastingsvindu
Opplastings-URL-en er gyldig i 10 minutter for å starte opplastingen.

Når du har en plassholder for metadatablokken for filen din, kan du sende en PUT -forespørsel til den returnerte UploadURL fra den forrige POST forespørselen. I PUT -forespørselen din, ta med følgende i overskriften:

  • "x-amz-server-side-encryption" med verdien "AES256"

  • "Content-Type" med verdien "application/pdf"

Endepunkt

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

cURL-eksempel

Kopier 
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

Svar

Hvis det lykkes, vil du få et 204 svar. For feil, se Vanlige HTML-svarkoder nederst i autentiseringsveiledningen vår.

 

Nå som du har en økt med PDF-filer, er det på tide å legge til brukere i økten. Initiativtakeren til økten (den nåværende brukeren) blir automatisk vert for økten og legges automatisk til i øktens brukere. Flere brukere kan alltid legges til mens økten er aktiv. Det finnes to metoder for å legge til brukere:

Denne metoden er best for å invitere brukere som kanskje ikke har en Studio-konto ennå. En e-post sendes til den inviterte med muligheten til å opprette en gratis Studio-konto.

Endepunkt

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

Parametere

Navn

Beskrivelse

Email

E-postadressen for å sende invitasjonen til

Eksempel

Kopier 
cURL https://api.bluebeam.com/publicapi/v1/sessions/{session}/invite \
-H "Autorisasjon: Bærer {token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: {client_id}" \
-d '{  
      "Email":"gavin.belson@hooli.com",  
      "Melding":"Bli med i denne seksjonen for å gjennomgå dokumenter angående Pied Piper-ervervelsen."
    }' \
-X POST

Svar

Hvis det lykkes, vil du få et 204 svar. For feil, se Vanlige HTML-svarkoder nederst i autentiseringsveiledningen vår.

ELLER

Denne metoden er best hvis du vet at e-postadressen allerede er knyttet til en Studio-konto, og du vil at de skal legges til i en Studio-økt uten å registrere seg. Hvis brukeren ikke har en konto, eller hvis de er usikker på om de har en, bruk metode A: Inviter bruker. Ved å bruke metode B: Legg til bruker, legges brukeren til i Studio-øktens deltakere, og Studio-økten vises under deres deltakere i Studio-fanen i Revu-grensesnittet.

Endepunkt

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

Parametere

Navn

Beskrivelse

Email

E-postadressen til den kjente Studio-kontoen

SendEmail

Boolsk; Sann: send en e-post til den inviterte, Usann: ikke send et e-postvarsel til den inviterte

Eksempel

Kopier 
cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/users](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/users)
-H "Autorisasjon: Bærer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-d '{  
      "E-post": "peter.gregory@raviga.com",
      "SendEmail": true,
      "Melding": "Som forespurt, her er sesjonen for å gjennomgå Pied Piper-anskaffelsesdokumentene."
    }' \
-X POST

Svar

Hvis det lykkes, vil du få et 204 svar. For feil, se Vanlige HTML-svarkoder nederst i autentiseringsveiledningen vår.

Eksempel på e-post med invitasjon til økt

 

For å avslutte en økt (vanligvis gjort etter at deltakerne er ferdige med å markere eller øktens utløpsdato er nådd), må statusen endres, filene må håndteres, og selve økten må kastes på riktig måte.

Hvis du setter statusen for en økt til Fullfører, fjernes alle brukere fra økten, unntatt verten. Dette gjøres for å forhindre ytterligere endringer i sesjonsfilene etter at de er nedlastet.

Endepunkt

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

Eksempel

Kopier 
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

Nedlasting av de merkede øktfilene er en prosess i to deler. Følg trinnene nedenfor for hver fil i økten.

i. Lag et øyeblikksbilde

I en økt lagres PDF-filer og markeringer separat. Et øyeblikksbilde kombinerer PDF-innholdet med markeringslaget til én PDF, slik at markeringene kan vises på PDF-en utenfor Studio-økten.

Endepunkt

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

Eksempel

Kopier 
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. Sjekk statusen til øyeblikksbildet, last ned hvis det er fullført

Send en GET -forespørsel til Snapshot-endepunktet til Status er enten Complete eller Error.

  • Hvis Error: Vi inkluderer en feilmelding som kan presenteres for brukeren.

  • Hvis Complete: Bruk DownloadUrl for å laste ned øyeblikksbildet

Endepunkt

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

Eksempel

Kopier 
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

Svartekst

Kopier 
{
    "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}"
}

Statusalternativer

Status

Beskrivelse

NoSnapshot

Når et øyeblikksbilde aldri har blitt kalt på en fil

Requested

Snapshot-jobben har ikke startet ennå, men vi mottok forespørselen

InProgress

Snapshot-jobben pågår

Complete

Snapshot-jobben er fullført og kan lastes ned via DownloadUrl

Error

Snapshot-jobben mislyktes. Statusen vil inneholde en feilmelding.

Nå som du har de markerte PDF-filene, kan du slette økten ved å sende en DELETE -forespørsel til økt-ID-endepunktet.

Endepunkt

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

Eksempel på avslutning av en økt

Kopier 
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

 

Konklusjon

Å returnere filen til den opprinnelige plasseringen og arkivere økten fullfører den typiske Studio-øktens livssyklus. Selv om det finnes mange forskjellige måter å jobbe med Studio Sessions på, håper vi at denne gjennomgangen har gitt deg en god forståelse av det grunnleggende.

 

Se også:

Ressurser

Revu 21

Developer Portal

Developer Portal

Denne veiledningen for Developer Portal dekker den generelle livssyklusen til en Studio-sesjon og inkluderer kodeeksempler.