Bluebeam Developer Portal에서 시작하세요

통합 개발을 위한 Bluebeam Developer Portal은 미국, 호주, 독일, 영국, 남동부 지역의 활성 고객, 채널 파트너 및 소프트웨어 파트너에게만 제공됩니다.

이 페이지는 새로운 Developer Portal을 안내해 드립니다. 각 단계를 별도의 탭에서 진행하는 동안 해당 탭을 별도 탭으로 열기하는 것이 좋습니다.

시작하려면 Bluebeam 계정을 생성하고 , 아직 Bluebeam Developer Portal에 대한 액세스를 요청하세요.

경로를 선택하세요:

Bluebeam API는 RESTful 이며 현재 2가지 범주의 엔드포인트가 있습니다.

  • 인증

  • Studio

모든 엔드포인트에 적용되는 지역별 기본 URL이 있습니다.

- 미국: https://api.bluebeam.com

- 독일: https://api.bluebeamstudio.de

- 호주: https://api.bluebeamstudio.com.au

- UK: https://api.bluebeamstudio.co.uk

- SE: https://api.bluebeamstudio.se

예를 들어, 미국에서 https://api.bluebeam.com/publicapi/v1/sessions가 발생하면 호주에서는 https://api.bluebeamstudio.com.au/publicapi/v1/sessions 가 됩니다.

인증

인증을 처리하는 방법에 대한 몇 가지 주요 노트:

  • OAuth 2.0을사용한 인증

    • 모든 API 호출은 사용자의 컨텍스트에서 이루어집니다. OAuth로 인증하면 사용자는 앱에 자신의 데이터에 접근하고 자신을 대신해 API 요청을 할 수 있는 권한을 부여합니다.

  • 모든 요청과 응답 본문은 JSON 형식이어야 합니다. 본문이 있는 모든 요청에 Content-Type: application/json 헤더를 Set합니다.

  • API 호출은 HTTPS를 통해 이루어져야 합니다.

  • 앱에 OAuth 2.0을 설정하려면 인증 가이드를 참조하세요.

Studio

Studio는 당사의 주력 데스크톱 애플리케이션인 Bluebeam Revu에 직접 연결되는 클라우드 협업 플랫폼입니다. Studio 엔드포인트는 Studio와 사용자 시스템 간의 원활한 통합을 위한 통신 선을 열어줍니다.

일반적으로 Studio API가 제공하는 기능은 사용자가 Revu의 Studio GUI를 통해 얻을 수 있는 기능과 동일한 것으로 생각할 수 있습니다.

Studio에 대해 자세히 알아보려면 Studio FAQ 페이지를 방문하세요.

이 절차는 Postman을 예로 들지만, 다른 API 소프트웨어 프로그램을 사용해서도 수행할 수 있습니다.

액세스 토큰을 발급받으려면 다음과 같이 진행하세요.

이 절차를 수행하려면 인증 가이드의 데이터가 필요합니다.

  1. Bluebeam 계정을 생성 하지 않았다면 Bluebeam Developer Portal에 대한 액세스를 요청하세요.

  2. developers.bluebeam.co.kr 으로 가서 로그인하세요.

  3. 액세스를 요청하고 Client ID를 생성합니다.

    1. 내 앱 으로 가서 액세스 요청을 클릭하세요.

    2. 액세스 요청 양식을 작성합니다(아래 스크린샷 참조). 해당 지역과 연결된 Bluebeam API 인스턴스를 선택합니다.

      Bluebeam Developer API는 미국 서버입니다.

      3. Bluebeam API는 Grant Type으로 다음 항목만 지원합니다.
      • Authorization Code(인증 코드)
      • Refresh Token(갱신 토큰)

    3. Redirect URI: https://oauth.pstmn.io/v1/callback을 사용합니다.

      이 URI는 Postman에서의 호출 전용입니다. 다른 API 도구나 사용자의 앱에는 다른 URI가 필요합니다.

    4. 양식을 제출하려면 요청을 선택하세요.

      5. 승인 이메일
      요청을 선택하면 "애플리케이션 등록 승인"이라는 제목의 MuleSoft 브랜드 이메일을 받게 되므로 무시하세요. 이는 당사의 기존 솔루션을 사용하면서 발생하는 또 다른 원치 않는 부작용입니다.

  4. 신임장을 받으세요. 이제 새로 등록한 앱이 목록에 표시됩니다(표시되지 않으면 브라우저를 새로 고치세요). 키 위에 마우스를 올려 놓으면 자격 증명을 얻을 수 있습니다.


  5. Postman을 통해 액세스 토큰을 받습니다.

    1. 데스크톱 앱이나 브라우저를 통해 Postman에 접속하여 무료 계정을 생성하세요.

    2. 다음은 Postman으로 가져올 수 있는 스크립트입니다. 이 스크립트는 사용 가능한 모든 Bluebeam API 호출 컬렉션입니다. Postman에서 File > Import로 이동하여 스크립트를 끌어다 놓습니다.

    3. Postman에서 access_token 얻으려면 Bluebeam API(스크립팅 xxx) 컬렉션을 선택하세요.

    4. Authorization 탭을 선택하여 Postman에서 새 토큰을 구성합니다.

      인증에 대한 자세한 내용은 인증 가이드를 참조하세요. 인증 가이드에 나오는 요청 매개변수는 Postman에서 변수라고 부릅니다.
      Postman에서 환경을 설정하여 인증용 변수를 생성하거나, Closed필수 값을 수동으로 입력할 수 있습니다.

      Postman의 필수 설정 및 값:

      • Auth Type: 반드시 OAuth 2.0이어야 합니다

      • Grant Type: Authorization Code(인증 코드)

      • Token Name: code(임의 값)

      • Grant Type: Authorization Code(인증 코드)

      • Authorize using browser를 활성화해야 합니다.

      • Auth URL: https://api.bluebeam.com/oauth2/authorize

      • Access Token URL: https://api.bluebeam.com/oauth2/token

      • Client ID: 앱 등록 과정에서 발급받은 Client ID

      • Client Secret: 앱 등록 과정에서 발급받은 Client Secret

      • Scope: Studio 엔드포인트의 범위, 최소 요구 사항은 offline_access

      • State: State(임의 값)

      • Client Authentication: Send client credentials in body(본문에 클라이언트 자격 증명 전송)

    5. 하단으로 스크롤하여 Get New Access Token을 클릭합니다.

    6. BBID로 로그인하고 메시지가 표시되면 액세스 허용을 클릭하세요. Postman, API 문서 또는 사용자 코드에서 사용할 수 있는 토큰이 제공됩니다.

토큰 만료
토큰은 1시간 후에 만료되므로 통화가 중단되면 프로세스를 다시 거쳐 새 토큰을 받으세요. 새로 고침 토큰을 사용하도록 OAuth를 설정하려면 인증 가이드를 참조하세요.

기존 통합을 새로운 플랫폼으로 마이그레이션하는 단계별 프로세스는 다음과 같습니다.

  1. 아직 BBID 계정이 없다면 만들어 보세요.

  2. developers.bluebeam.co.kr 으로 가서 로그인하세요.

  3. 새로운 앱을 등록하세요.

    1. 내 앱 으로 가서 액세스 요청을 선택하세요.

    2. 접근 요청 양식을 채우세요(아래 스크린샷 참조). 귀하의 특정 지역과 관련된 Bluebeam API 인스턴스를 선택하세요.

      보조금 유형에 대한 노트:

      다음 옆의 상자 만 선택하세요:

      • 인증 코드
      • 새로 고침 토큰

    3. 양식을 제출하려면 요청을 선택하세요.

  4. 신임장을 받으세요. 이제 새로 등록된 앱이 목록에 표시됩니다. 키 위에 마우스를 올려 놓으면 자격 증명을 얻을 수 있습니다.


  5. 아래 나열된 권한 부여 및 Studio 엔드포인트에 대한 새로운 API 경로를 사용하여 기존 통합을 업데이트하세요.

    미국 서버

    환경

    원래 기본 경로

    새로운 기본 경로

    승인 - 생산(미국)

    https://authserver.bluebeam.com/auth/oauth/authorize

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

    승인 - 생산(미국)

    https://authserver.bluebeam.com/auth/token

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

    Studio - 프로덕션(미국)

    https://studioapi.bluebeam.com:443/publicapi/v1

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

  6. 통합에서 기존 클라이언트 ID와 클라이언트 비밀번호가 구성된 경우 이를 새 클라이언트 ID와 비밀번호로 바꾸세요.

  7. API 호출에서 "client_id"라는 헤더와 새 클라이언트 ID 값을 추가합니다. 이는 새로운 플랫폼에 대한 모든 요청에 필요합니다.

    노트
    저희는 오류 메시지를 보다 정확하고 의미 있게 만들기 위해 계속 노력하고 있지만, 그동안 "client_id" 헤더 없이 요청을 보내면 다음과 같은 오류 메시지가 표시됩니다.

    copy
    {
        "msg": "Internal Server Error"
    }

  8. 새로운 플랫폼은 기존 플랫폼과 약간 다르게 인증을 처리하므로 새로운 인증 가이드를 검토하는 것이 좋습니다. 주목할 만한 두 가지 변화:

    • 새로 고침 토큰에 대한 offline_access 범위를 출시 제품했습니다( 인증 가이드 의 1단계 참조).

    • 토큰 엔드포인트 응답이 변경되었습니다(응답 예시는 인증 가이드 참조).

  9. 모든 것이 올바르게 구성된 경우 모든 Studio 엔드포인트에 대해 이전 Studio API의 응답과 동일한 응답을 받아야 합니다.
    예를 들어, Studio 프로젝트 목록을 요청한 경우 응답 본문은 다음과 같습니다.

    copy 
    {
      "$id": "1"
      "Projects": [
        {
          "$id": "2",
          "Id": "385-509-537",
          "Guid": "Mzu1D6xhLE2bE0y2F4ozfQ",
          "Name": "테스트 프로젝트 이름",
          "Restricted": true,
          "Created": "2024-02-29T17:40:58.043",
          "OwnerNameIdentifier": "e149e277-3052-4f3e-a376-29fc6c5aa76c",
          "OwnerEmail": "jdoe@bluebeam.com"
        }
      ]
    }

  10. 앱을 테스트한 후 문제가 발생하면 알려주세요.

 

또한 참조하세요:


리소스

Revu 21

Developer Portal

Developer Portal

이 페이지는 새로운 Developer Portal을 안내합니다.