Studio 세션 가이드

엔드포인트

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

매개변수

cURL 예제

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

예시 응답

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

업로드 창
업로드 URL은 업로드를 시작하기 위해 10분 동안 유효합니다.

파일에 대한 메타데이터 블록 자리 표시자가 생기면 이전 POST 요청에서 반환된 UploadURL 에 PUT 요청을 수행합니다. PUT 요청에서 헤더에 다음을 포함하세요.

• "x-amz-server-side-encryption" 값 "AES256"

• 값이 "application/pdf" "Content-Type"

엔드포인트

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

cURL 예제

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

대응

성공하면 204 응답을 받게 됩니다. 오류에 대해서는 인증 가이드 하단의 일반 HTML 응답 코드를 참조하세요.

이 방법은 아직 Studio 계정이 없는 사용자를 초대하는 데 가장 좋습니다. 초대받은 사람에게 무료 Studio 계정을 생성할 수 있는 기회가 담긴 이메일이 전송됩니다.

엔드포인트

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

매개변수

예

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":"Pied Piper 인수 관련 문서를 검토할 수 있도록 이 세션에 참여해 주세요."
    }' \
-X POST

대응

성공하면 204 응답을 받게 됩니다. 오류에 대해서는 인증 가이드 하단의 일반 HTML 응답 코드를 참조하세요.

이 방법은 해당 이메일 주소가 이미 Studio 계정과 연결되어 있고, 가입하지 않고도 Studio 세션에 추가하려는 경우에 가장 좋습니다. 사용자에게 계정이 없거나 계정이 있는지 확실하지 않은 경우 방법 A: 사용자 초대를 사용하세요. 방법 B: 사용자 추가를 사용하면 사용자가 Studio 세션의 참석자에 추가되고, Studio 세션은 Revu 인터페이스의 Studio 탭에 있는 참석 세션에 나타납니다.

엔드포인트

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

매개변수

예

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": "요청하신 대로, Pied Piper 인수 문서를 검토할 수 있는 세션입니다."
    }' \
-X POST

대응

성공하면 204 응답을 받게 됩니다. 오류에 대해서는 인증 가이드 하단의 일반 HTML 응답 코드를 참조하세요.

샘플 세션 초대 이메일

세션 상태를 완료 중으로 설정하면 호스트를 제외한 모든 사용자가 세션에서 제거됩니다. 이는 세션 파일을 다운로드한 후에 해당 파일이 더 이상 변경되지 않도록 방지하기 위해 수행됩니다.

엔드포인트

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

예

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

표시된 세션 파일을 다운로드하는 과정은 2단계로 구성됩니다. 세션의 각 파일에 대해 아래 단계를 따르세요.

i. 스냅샷 생성

세션 중에는 PDF와 마크업이 별도로 저장됩니다. 스냅샷은 PDF 콘텐츠와 마크업 레이어를 단일 PDF로 결합하여 Studio 세션 외부의 PDF에서 마크업을 볼 수 있도록 합니다.

엔드포인트

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

예

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. 스냅샷 상태 확인, 완료되면 다운로드

Status Complete 또는 Error 될 때까지 스냅샷 엔드포인트에 GET 요청을 만듭니다.

• Error 의 경우: 사용자에게 표시될 수 있는 오류 메시지를 포함합니다.

• Complete 되면: DownloadUrl 사용하여 스냅샷을 다운로드하세요.

엔드포인트

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

예

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

대응 기관

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

상태 옵션

이제 마크업된 PDF가 있으므로 세션 ID 엔드포인트에 DELETE 요청을 보내서 세션을 삭제할 수 있습니다.

엔드포인트

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

세션 종료 예

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