Bluebeam Developer Portalで始めましょう

Okta 経由で BBID 資格情報を使用してログインすると、ポータルは即座に資格を検証します。ソフトウェア開発者またはパートナーでない限り、パートナーシップチームへの手動による導入リクエストやメールは必要ありません。

サブスクリプションの要件

ログイン時に、ポータルはアカウントが3つの条件すべてを満たしていることを確認します：

• 有効な BBID アカウント

• 有効な Core、Complete、または Max サブスクリプション

  • Basics プランは対象外です：Basics プラン加入者は、ほとんどの統合に不可欠な操作であるプロジェクトやセッションを作成できないため、Developer Portal にアクセスできません。アクセスするには、Core、Complete、または Max にアップグレードしてください。

  • ソフトウェア開発者とパートナーの方へ：Bluebeam Partnerships を通じて特別な NFR ライセンスが必要な場合は、Bluebeam Developer Portal へのアクセスをリクエストする必要があります。

• 対象地域：US、AU、DE、UK、および SE

すべての新しいアプリは、Sandbox環境でデフォルトで作成されます。Sandboxを使用すると、エンドユーザーに提供される前に、統合を安全に構築およびテストするための専用スペースが提供されます。

• アプリが本番環境に移行しても、サンドボックスの認証情報は一貫して保持されます。

• 本番環境にプロモートする際、レート制限は実際の使用上の制約に対応するように調整されます。

• アプリは、明示的に本番環境での承認をリクエストするまでサンドボックスに留まります（「ステップ 6」を参照してください）。

アプリ作成フローは再設計されました。アプリケーション作成フォームには、Bluebeam 統合に関連するフィールドのみが表示されます。

プラットフォームと地域

1. [My Apps] に移動し、[アプリケーションを作成] を選択します。

2. アプリケーションの作成時に、お使いの地域に一致する API インスタンスを選択します：
   

   • 米国: https://api.bluebeam.com

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

   • AU: https://api.bluebeamstudio.com.au

   • UK: 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 は、付与タイプに対して次の選択肢のみをサポートしています：

   • 認証コード：すべての API 呼び出しは OAuth 2.0 を使用します；ユーザーは、アプリがユーザーに代わって動作することを許可します。

   • リフレッシュトークン

5. リダイレクト URI：https://oauth.pstmn.io/v1/callback を使用します。
   この URI は Postman での呼び出し専用です。代替 API ツールやご利用のアプリでは、異なる URI が必要です。

6. フォームを送信するには、アプリケーションを作成 を選択します。
   フォームを送信すると、件名「Application registration approved」の MuleSoft ブランドのメールが届きます。メールを無視してください。当社の既製ソリューションを使用することによる、意図しない副作用です。

7. 資格情報を取得します。これで、新しく作成したアプリがリストに表示されるはずです (表示されない場合は、ブラウザを更新してください)。アプリの線のどこかをクリックすると、クライアント ID とクライアントシークレットを表示できる詳細ページが開きます。
   
   

8. テストでPostmanを使用する場合は、Postman経由でアクセストークンを取得します。

   1. デスクトップ アプリまたはブラウザーからPostman にアクセスし、無料アカウントを作成します。

   2. こちらは Postman にインポートできるスクリプトです。このスクリプトは、使用可能なすべての Bluebeam API 呼び出しのコレクションです。Postman で、[ファイル] > [インポート] に移動し、スクリプトをドロップします。

   3. Postman でaccess_tokenを取得するには、 Bluebeam API (スクリプト作成 xxx)コレクションを選択します。

   4. Postman で新しいトークンを設定するには、[認証] タブを選択します。
      

      認証に関する詳細は認証ガイドをご覧ください。認証ガイドではリクエストパラメータを参照しています。これらは Postman では変数と呼ばれます。
      Postman で環境を設定して認証用の変数を作成するか、必要な値を手動で入力することもできます。

      Postman の必須設定と値：

      • 認証タイプ：OAuth 2.0 が必要です

      • 付与タイプ：認証コード

      • トークン名：code

      • 付与タイプ：認証コード

      • ブラウザでの承認は有効にする必要があります。

      • 認証 URL：https://api.bluebeam.com/oauth2/authorize

      • アクセストークン URL：https://api.bluebeam.com/oauth2/token

      • クライアント ID：アプリ登録プロセス中に受信したクライアント ID

      • クライアントシークレット：アプリ登録プロセス中に受信したクライアントシークレット

      • スコープ：Studio エンドポイントのスコープ。最低限必要なのは offline_access です

      • 都道府県：都道府県

      • クライアント認証：クライアント認証情報を本文で送信

   5. 一番下までスクロールし、[新しいアクセストークンを取得] を選択します。
   6. BBIDでサインインし、プロンプトが表示されたら [アクセスを許可] を選択します。Postman、当社の API ドキュメント、または独自のコードで使用できるトークンが表示されます。

「マイアプリ」テーブルに、主なアプリの詳細が一目でわかるように追加の列が更新されました。

• 名前：作成したアプリ名。

• クライアント ID：すべての API リクエストで使用される一意の識別子です。

• 環境：現在のステータス（サンドボックス、保留中、または本番環境）。

• 作成日: アプリが作成された日付。

• リージョン：アプリが作成されたAPIリージョン

• アクション：編集、削除、資格情報の表示、またはProduction Approvalの申請を行うには、選択します。

テーブルの下部に、複数のアプリを管理している場合は前後のページを表示します。

エンドポイントを検索

新しいキーワード検索バーを使用すると、完全なリファレンスをスクロールすることなく、すべてのエンドポイントとパラメータを検索できます。キーワード（例：セッション、マークアップ）を入力して、関連するエンドポイントにジャンプします。

テストリクエスト

各APIエンドポイントに、「テストリクエスト」ボタンが新しく含まれています。選択すると、ブラウザ内パネルが開き、次のことができます：

• クエリパラメータとリクエストボディの塗りつぶし

• ドキュメントから直接ライブAPIコールを実行

• 完全なレスポンスをインラインで表示

• コーディング言語（Python、cURL など）を切り替える

現在利用可能：マークアップ API エンドポイントはベータ版ではなくなり、すべての開発者にご利用いただけます。追加のアクセスは必要ありません。

アプリがサンドボックスで構築およびテストされたら、[My Apps] のアプリの詳細ページで [本番承認をリクエスト] を選択します。これにより、デフォルトの電子メールクライアントで integrations@bluebeam.com 宛に、あらかじめ宛先が入力されたメールが開きます。

メールには以下の情報を含める必要があります：

提出後のアプリステータス

• アプリのステータスは、承認リクエストが送信されると保留中に変わります。

• 最終承認後、アプリは運用環境に昇格されます。

• 統合アプリが承認されたことを通知するメールが届き、ポータルでステータスが本番環境に変更されます。