Vejledning til Studio-sessioner

Bluebeam Developer Portal til integrationsudvikling er kun tilgængelig for aktive kunder, kanalpartnere og softwarepartnere i USA, Australien, Tyskland, Storbritannien og Sverige.

Tænk på en Studio-session som et digitalt mødelokale, hvor PDF-tegninger kan markeres enten samtidigt eller asynkront. Denne vejledning dækker den generelle livscyklus for en Studio-session og indeholder kodeeksempler. Hvis du vil vide mere om Studio- og Studio-sessioner generelt, kan du besøge vores side med ofte stillede spørgsmål om Studio.

Du kan følge med i denne vejledning og prøve mange af funktionerne i Studio-sektionen i vores API-dokumentation. Se vores vejledning Kom i gang med at bruge Bluebeam Developer Portal for instruktioner om, hvordan du får en gyldig adgangstoken.

Der er områdespecifikke basis-URL-adresser, der gælder for alle slutpunkter:

USA: https://api.bluebeam.com
Tyskland: https://api.bluebeamstudio.de
Australien: https://api.bluebeamstudio.com.au
UK: https://api.bluebeamstudio.co.uk
SE: https://api.bluebeamstudio.s

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

Livscyklus for Studio-sessioner

Livscyklussen for en Studio-session kan opdeles i 4 dele:

Initialisering – Åbner det "digitale mødelokale"
Tilføj PDF-filer til sessionen for visning og markering
Føj brugere til sessionen, så de kan se og markere
Færdiggørelse – Lukker sessionen og returnerer de annoterede PDF-filer til deres oprindelige system

1. Initialiser session

Den første fase af en Studio-sessions livscyklus er dens oprettelse. For at begynde skal du lave en POST-kommando til sessionens slutpunkt med følgende parametre.

Slutpunkt

Kopiér

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

Sørg for at medtage client_id i overskriften på din anmodning.

Anmodningsparametre

Navn	Beskrivelse	Værditype/Mulige værdier
`Navn`	Sessionsnavn	Streng
`Notification`	`true`: Den nuværende bruger abonnerer på e-mailmeddelelser om ændringer i denne session. `false`: Den nuværende bruger abonnerer ikke på e-mailmeddelelser om ændringer i denne session.	Boolean
`Restricted`	`true`: Begrænser sessionen til kun at omfatte e-mailadresser, der er blevet inviteret eller tilføjet. `false`: Lader sessionen være åben for alle, der har det 9-cifrede sessions-ID.	Boolean
`SessionEndDate`	Når denne dato er nået, vil alle deltagere undtagen værten blive fjernet fra sessionen.	Must be formatted in UTC format.
`DefaultPermissions`	Dette tilladelsessæt gælder for alle brugere, der føjes til denne session, undtagen værten (den aktuelle bruger). Værten får fuld kontrol.	Definer typer af tilladelser og selv tilladelser nedenfor.

Tilladelse	Beskrivelse	Værditype/Mulige værdier
`Type`	Type tilladelse	`SaveCopy` – Tillad deltagere at gemme som. `PrintCopy` – Tillad deltagere at udskrive PDF-filer, der er inkluderet i sessionen. `Markering` – Tillad deltagere at placere markeringer. `Tilføj Dokumenter` – Giv deltagerne mulighed for at tilføje nye dokumenter til sessionen. `FullControl` – Giv deltagere administratorrettigheder til sessionen. `MarkupAlert` – Giv deltagere mulighed for at sende og modtage markeringsadvarsler under sessionen.
`Allow`	Tilladelsestilstand	Tillad, Afvis, Standard

Tilladelse

Beskrivelse

Værditype/Mulige værdier

Type

Type tilladelse

SaveCopy – Tillad deltagere at gemme som.

PrintCopy – Tillad deltagere at udskrive PDF-filer, der er inkluderet i sessionen.

Markering – Tillad deltagere at placere markeringer.

Tilføj Dokumenter – Giv deltagerne mulighed for at tilføje nye dokumenter til sessionen.

FullControl – Giv deltagere administratorrettigheder til sessionen.

MarkupAlert – Giv deltagere mulighed for at sende og modtage markeringsadvarsler under sessionen.

Allow

Tilladelsestilstand

Tillad, Afvis, Standard

Sessionens slutdato
Sessionens slutdato er ikke påkrævet, men hvis der vælges en slutdato for sessionen, får deltagerne i sessionen besked via e-mail 7 dage, 2 dage og 24 timer før udløbsdatoen.

cURL-eksempel

Kopiér

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

Tilladelser
Nuværende Studio-brugere er ofte vant til specifikke standardindstillinger for tilladelser. Det er altid en god idé enten at kontrollere, hvad standardtilladelserne skal være, eller give brugerne mulighed for at vælge deres tilladelser. Når du bruger Bluebeam API til at indstille tilladelser, er 'Afvis' standardværdien.

Svartekst

Kopiér

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

2. Tilføj PDF-filer

Det næste trin er at tilføje PDF-filerne. Tilføjelse af filer er en proces i tre trin:

Opret metadatablokken for filen via Bluebeam API
Upload filen direkte til AWS
Bekræft upload via Bluebeam API

Bemærk: Studio-sessioner understøtter ikke PDF/A-filer.
Da PDF/A er et arkiveringsformat, tillader det ikke redigering og vil medføre, at trin 4 nedenfor mislykkes.

a. Opret metadatablok

Slutpunkt

Kopiér

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

Parametre

Navn	Beskrivelse	Værditype/Mulige værdier
`Navn`	Navn på fil	Streng, der slutter på ".pdf"
`Source`	Kildesti; Dette kan hjælpe dig med at identificere, hvor filen kom fra senere i processen	Streng
`Size`	Filstørrelse; efterlad null for serveren at beregne	Heltal
`CRC`	Lad null for serveren beregne	Streng

cURL-eksempel

Kopiér

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

Eksempel på svar

Kopiér

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

Vinduet Overførsel
Upload URL er gyldig i 10 minutter for at starte upload.

c. Bekræft upload

Slutpunkt

Kopiér

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

cURL-eksempel

Kopiér

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, får du et 204-svar. For fejl, se de almindelige HTML-svarkoder nederst i vores Authentication Guide.

3. Tilføj brugere

Nu, hvor du har en session med PDF-filer, er det tid til at tilføje brugere til sessionen. Initiativtageren til sessionen (den aktuelle bruger) bliver automatisk vært for sessionen og føjes automatisk til sessionens brugere. Der kan altid tilføjes flere brugere, mens sessionen er aktiv. Der er to metoder til at tilføje brugere:

Metode A: Inviter bruger

Denne metode er bedst til at invitere brugere, der muligvis ikke har en Studio-konto endnu. Der sendes en e-mail til den inviterede med en mulighed for at oprette en gratis Studio-konto.

Slutpunkt

Kopiér

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

Parametre

Navn	Beskrivelse
`Email`	E-mailadresse, som invitationen skal sendes til

eksempel

Kopiér

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 '{  
      "Email":"gavin.belson@hooli.com",  
      "Message":"Deltag i denne session for at gennemgå dokumenter vedrørende overtagelsen af Pied Piper."
    }' \
-X POST

Svar

Hvis det lykkes, får du et 204-svar. For fejl, se de almindelige HTML-svarkoder nederst i vores Authentication Guide.

ELLER

Metode B: Tilføj bruger

Denne metode er bedst, hvis du ved, at e-mailadressen allerede er knyttet til en Studio-konto, og du ønsker, at de skal føjes til en Studio-session uden at tilmelde dig. Hvis brugeren ikke har en konto, eller hvis vedkommende er usikker på, om de har, skal du bruge metode A: Inviter bruger. Ved hjælp af metode B: Tilføj bruger føjes brugeren til Studio-sessionens deltagere, og Studio-sessionen vises under deres deltagende sessioner på fanen Studio i Revu-grænsefladen.

Slutpunkt

Kopiér

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

Parametre

Navn	Beskrivelse
`Email`	E-mailadressen på den kendte Studio-konto
`SendEmail`	Boolean; True: Send en e-mail til den inviterede, False: Send ikke en e-mailmeddelelse til den inviterede

eksempel

Kopiér

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 '{  
      "Email": "peter.gregory@raviga.com",
      "SendEmail": true,
      "Message": "Som ønsket er her sessionen til gennemgang af dokumenterne vedrørende overtagelsen af Pied Piper."
    }' \
-X POST

Svar

Hvis det lykkes, får du et 204-svar. For fejl, se de almindelige HTML-svarkoder nederst i vores Authentication Guide.

Eksempel på invitationsmail til session

4. Afslut session

For at afslutte en session (typisk efter, at deltagerne er færdige med at markere, eller sessionens udløbsdato er nået), skal dens status ændres, dens filer skal behandles, og selve sessionen skal bortskaffes korrekt.

a. Indstil status til Færdiggør

Hvis en sessions status indstilles til Færdiggør, fjernes alle brugere fra sessionen undtagen værten. Dette gøres for at forhindre yderligere ændringer i sessionsfilerne, når de er downloadet.

Slutpunkt

Kopiér

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

eksempel

Kopiér

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. Download de markerede sessionsfiler

Download af de annoterede sessionsfiler er en proces i to dele. Følg nedenstående trin for hver fil i sessionen.

i. Opret et Snapshot

I en session gemmes PDF-filer og markeringer separat. Et Snapshot kombinerer PDF-indholdet med markeringslaget til en enkelt PDF-fil, så markeringerne er synlige i PDF-filen uden for Studio-sessionen.

Slutpunkt

Kopiér

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

eksempel

Kopiér

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. Kontroller status for Snapshot, download, hvis fuldført

Foretag en GET-anmodning til Snapshot-slutpunktet, indtil status er enten Complete eller Error.

If Error: Vi inkluderer en fejlmeddelelse, der kan vises til brugeren.
If Complete: Brug DownloadUrl til at downloade Snapshot

Slutpunkt

Kopiér

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

eksempel

Kopiér

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

Kopiér

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

Statusindstillinger

Status	Beskrivelse
`NoSnapshot`	Når et Snapshot aldrig er blevet kaldt på en fil
`Requested`	Snapshot-jobbet er endnu ikke startet, men vi har modtaget anmodningen
`InProgress`	Snapshot-jobbet er i gang
`Complete`	Snapshot-jobbet er færdigt og kan downloades via `DownloadUrl`
`Error`	Snapshot-jobbet mislykkedes. Status vil indeholde en fejlmeddelelse.

c. Afslut sessionen

Nu, hvor du har den eller de markerede PDF-filer, kan du bortskaffe sessionen ved at sende en DELETE-anmodning til sessions-ID-slutpunktet.

Slutpunkt

Kopiér

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

Eksempel på afslutning af en session

Kopiér

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

Konklusion

At returnere filen til dens oprindelige placering og arkivering af sessionen fuldender den typiske Livscyklus for Studio-sessioner. Selvom der findes mange forskellige måder at arbejde med Studio-sessioner på, håber vi, at denne gennemgang har givet dig et godt kendskab til det grundlæggende.

Se også:

Ressourcer

Revu 21

Developer Portal

Denne vejledning til Developer Portal dækker den generelle livscyklus for en Studio-session og indeholder kodeeksempler.