Bluebeam Developer Portal에서 시작하세요

Okta를 통해 BBID 자격 증명으로 로그인하면 포털에서 즉시 귀하의 자격을 확인합니다. 소프트웨어 개발자 및/또는 파트너가 아닌 한 파트너십 팀에 수동 온보딩 요청이나 이메일을 보낼 필요가 없습니다.

구독 필요 사항

로그인 시, 포털에서 계정이 세 가지 기준을 모두 충족하는지 확인합니다:

• 유효한 BBID 계정

• 활성 Core, Complete 또는 Max 구독

  • Basics 플랜은 해당되지 않습니다: Basics 구독자는 대부분의 통합에 중요한 작업인 프로젝트 및 세션을 생성할 수 없으므로 Developer Portal에 액세스할 수 없습니다. 액세스하려면 Core, Complete 또는 Max로 업그레이드하십시오.

  • 소프트웨어 개발자 및 파트너: Bluebeam Partnerships를 통해 특별 NFR 라이선스가 필요한 경우, Bluebeam Developer Portal에 대한 액세스를 요청해야 합니다.

• 대상 지역: 미국, 호주, 독일, 영국 및 스웨덴

모든 새 앱은 기본적으로 샌드박스 환경에서 생성됩니다. 샌드박스는 최종 사용자에게 도달하기 전에 통합을 안전하게 빌드하고 테스트할 수 있는 전용 공간을 제공합니다.

• 샌드박스 자격 증명은 앱이 프로덕션 환경으로 이전될 때 일관되게 유지됩니다.

• 프로덕션으로 승격 시, 요율 제한은 실제 사용 제약을 지원하도록 조정됩니다.

• 프로덕션 승인을 명시적으로 요청할 때까지 앱은 샌드박스에 유지됩니다 (6단계 참조).

앱 생성 흐름이 재설계되었습니다. 애플리케이션 생성 양식은 Bluebeam 통합과 관련된 필드만 표시합니다.

플랫폼 및 지역

1. 내 앱 으로 이동하여 애플리케이션 생성을 선택합니다.

2. 애플리케이션을 생성할 때 사용자 지역과 일치하는 API 인스턴스를 선택합니다.
   

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

   • DE: https://api.bluebeamstudio.de

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

   • 영국: https://api.bluebeamstudio.co.uk

   • SE: https://api.bluebeamstudio.s

   
   

등록 양식 필드

3. 등록 양식 필드 채우기:

   • 애플리케이션 이름: 최대 90자까지 입력하세요.

   • 설명: 최대 300자를 입력합니다.

   • 지역: 해당 지역의 Bluebeam API 인스턴스를 선택하세요.

   • 리디렉션 URL: 쉼표로 구분된 값을 입력하거나 Enter 키를 누르면 포털에서 페이지가 매겨진 목록으로 정리됩니다.

   • Postman으로 테스트 중이신가요? 리디렉션 URI의 경우, https://oauth.pstmn.io/v1/callback을(를) 사용하세요. 귀사의 프로덕션 앱은 다른 URI를 사용합니다.

인증 노트

4. Bluebeam API는 Grant Type으로 다음 선택 항목만 지원합니다.

   • Authorization Code(인증 코드): 모든 API 호출은 OAuth 2.0을 사용하며, 사용자가 사용자 대신 앱이 작동하도록 권한을 부여합니다.

   • Refresh Token(갱신 토큰)

5. 리디렉션 URI:https://oauth.pstmn.io/v1/callback 을(를) 사용하세요.
   이 URI는 Postman에서의 호출 전용입니다. 다른 API 도구 또는 사용자의 앱에는 다른 URI가 필요합니다.

6. 양식을 제출하려면 애플리케이션 생성 을(를) 선택합니다.
   양식을 제출하면 제목이 “애플리케이션 등록 승인됨.”인 MuleSoft 브랜드 이메일을 받게 됩니다. 이 이메일을 무시해 주십시오. 이것은 기본 제공 솔루션을 사용할 때 발생하는 원치 않는 부작용입니다.

7. 자격 증명을 가져오세요. 이제 새로 생성된 앱이 목록에 표시될 것입니다(표시되지 않으면 브라우저를 새로고침하세요). 앱 선의 아무 곳이나 클릭하면, 클라이언트 ID와 클라이언트 시크릿을 볼 수 있는 세부 정보 페이지가 열립니다.
   
   

8. Postman으로 테스트하는 경우, Postman에서 액세스 토큰을 가져옵니다.

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

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

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

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

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

      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. 아래로 스크롤하여 새 액세스 토큰 받기를 선택하세요.
   6. BBID로 로그인한 후 안내가 표시되면 접근 허용을 선택합니다. Postman, API 문서 또는 사용자 고유 코드에서 사용할 수 있는 토큰이 표시됩니다.

내 앱 테이블이 추가 열로 업데이트되어 주요 앱 세부 정보를 한눈에 볼 수 있습니다.

• 이름: 사용자 생성 앱 이름

• 클라이언트 ID: 모든 API 요청에 사용되는 고유 식별자.

• 환경: 현재 상태(샌드박스, 보류 중 또는 프로덕션)

• 생성 날짜: 앱이 생성된 날짜

• 지역: 앱이 생성된 API 지역

• 작업: 편집, 삭제, 자격 증명 보기 또는 프로덕션 승인 요청을 선택.

여러 앱을 관리하는 경우 테이블 하단에서 이전 및 다음 페이지를 확인하세요.

엔드포인트 검색

새 키워드 검색 창을 사용하면 전체 참조를 스크롤하지 않고도 모든 엔드포인트와 파라미터에서 검색할 수 있습니다. 관련 엔드포인트로 이동하려면 키워드(예: 세션, 마크업)를 입력합니다.

테스트 요청

각 API 엔드포인트에는 이제 테스트 요청 버튼이 포함됩니다. 선택하여 다음 작업을 수행할 수 있는 브라우저 내 패널 열기:

• 쿼리 매개변수 및 요청 본문 채우기.

• 문서에서 라이브 API 호출을 직접 실행하세요.

• 전체 응답을 인라인으로 확인하세요.

• 코딩 언어(Python, cURL 등) 간 전환

지금 이용 가능: 마크업 API 엔드포인트가 베타 버전에서 출시되었으며 모든 개발자가 사용할 수 있습니다. 추가 액세스는 필요하지 않습니다.

앱을 샌드박스에서 빌드하고 테스트한 후, 내 앱의 앱 세부 정보 페이지에서 **프로덕션 승인 요청**을 선택합니다. 이렇게 하면 기본 이메일 클라이언트에서 integrations@bluebeam.com으로 미리 주소가 지정된 이메일이 열립니다.

이메일에 다음 정보를 포함해야 합니다.

제출 후 앱 상태

• 승인 요청이 제출되면 앱 상태가 보류 중으로 변경됩니다.

• 최종 승인 후, 앱이 프로덕션 환경으로 승격됩니다.

• 통합 앱이 승인되었다는 이메일을 받게 되며, Portal에서 상태가 Production으로 변경됩니다.