Bluebeam Developer Portalで始めましょう

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 のよくある質問をご覧ください。

アクセストークンを取得する

処理を高速化するには、 Postmanというアプリを使用することをお勧めします。方法は次のとおりです。

Bluebeam アカウントを作成し、まだお持ちでない場合はBluebeam Developer Portal へのアクセスをリクエストしてください。
developers.bluebeam.com/jpにアクセスしてログインします。
アクセスするには登録してください。
1. 「マイアプリ」に移動して、 「アクセスをリクエスト」をクリックします。
2. アクセスリクエストフォームを塗りつぶし（下のスクリーンショットを参照）。特定のリージョンに関連付けられた Bluebeam API インスタンスを選択します。
3. リダイレクト URI: https://oauth.pstmn.io/v1/callbackを使用します
4. フォームを送信するには「リクエスト」を選択してください。
資格情報を取得します。これで、新しく登録したアプリがリストに表示されるはずです (表示されない場合は、ブラウザを更新してください)。キーの上にマウスを移動すると、資格情報を取得できます。
Postman 経由でアクセストークンを取得します。
1. デスクトップアプリまたはブラウザーからPostman にアクセスし、無料アカウントを作成します。
2. 以下は Postman にインポートできるスクリプトです。Postman で、 「ファイル > インポート」に移動し、スクリプト作成を下ります。
3. Postman でaccess_tokenを取得するには、 Bluebeam API (スクリプト作成 xxx)コレクションを選択します。
4. 「承認」タブに移動し、オレンジ色の {{client_id}} 変数と {{client_secret}} 変数を、「マイアプリ」で受け取ったクライアント ID とクライアントシークレットに置き換えます。
5. 一番下までスクロールして、 「新しいアクセストークンの取得」をクリックします。
6. BBID でサインインし、プロンプトが表示されたら「アクセスを許可」をクリックします。Postman、API ドキュメント、または独自のコードで使用できるトークンが表示されます。

トークンの有効期限
トークンは 1 時間後に期限切れになります。そのため、通話が機能しなくなった場合は、再度プロセスを実行して新しいトークンを取得してください。リフレッシュトークンを使用するように OAuth を設定するには、認証ガイドを参照してください。

移行ガイド

既存の統合を新しいプラットフォームに移行するための手順を次に示します。

まだお持ちでない場合は、 BBID アカウントを作成してください。
developers.bluebeam.com/jpにアクセスしてログインします。
新しいアプリを登録します。
1. 「マイアプリ」に移動して、 「アクセスをリクエスト」を選択します。
2. アクセスリクエストフォームを塗りつぶし（下のスクリーンショットを参照）。特定のリージョンに関連付けられた Bluebeam API インスタンスを選択します。
  助成の種類に関するメモ:
  次の横にあるボックスのみを選択してください:
  - 認証コード
  - リフレッシュトークン
3. フォームを送信するには「リクエスト」を選択してください。
資格情報を取得します。これで、新しく登録したアプリがリストに表示されるはずです。キーの上にマウスを移動すると、資格情報を取得できます。

以下にリストされている承認および 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

統合内で従来のクライアント ID とクライアントシークレットが構成されている場合は、それらを新しいクライアント ID とクライアントシークレットに置き換えます。
API 呼び出しで、新しいクライアント ID の値を含む「 client_id 」というヘッダーを追加します。これは、新しいプラットフォームに届くすべてのリクエストに必要です。

メモ
エラーメッセージの正確性とわかりやすさの向上に引き続き取り組んでいますが、その間、 "client_id"ヘッダーなしでリクエストを送信すると、次のようなエラーメッセージが表示されます:
copy
```
{
    "msg": "Internal Server Error"
}
```
新しいプラットフォームでは、認証の処理方法が古いプラットフォームと若干異なるため、新しい認証ガイドを確認することをお勧めします。注目すべき 2 つの変更点:
- リフレッシュトークン用のoffline_accessスコープを製品の導入:しました (認証ガイドの手順 1 を参照)。
- トークンエンドポイントの応答が変更されました (応答例については、認証ガイドを参照してください)。
すべてが正しく設定されていれば、すべての 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"
}
]
}
```
やったね！アプリをテストして、問題が発生した場合はお知らせください。

参照:

リソース

Revu 21

Developer Portal

このページでは、新しい Developer Portal をご案内します。