オープンAPI はデータにアクセスし、ユーザーアカウントとコンピュータを管理できるようにする新機能です。また、オープンAPI を使用して、 On-Prem機能を独自の企業環境に統合するアプリを開発することもできます。
以下の手順に従って、チームのオープンAPIアプリケーションを申請してください。
詳細はAPIリファレンスをご確認ください。
要件
- Splashtop Gateway v3.24.0以降
- ライセンスでオープンAPIが【有効】になっていること
設定の流れ
1. ライセンスでオープンAPIが【有効】になっていることを確認します。
ご不明な点がございましたら、 営業担当までお問い合わせください。
2. チームオーナーの認証情報を使用してGatewayにログインします。
3. 「管理」⇒「チームの設定」⇒「API」に移動し、API設定ページの「API アプリケーションを追加」ボタンをクリックします。
4. APIアプリケーションの名前 を入力し、 API権限（読み取りまたは書き込み）を設定し、「追加」ボタンをクリックします。
- 名前：表示用の API アプリケーション名です。
-
権限：APIアプリケーションのAPI権限を設定します。
- 管理 この項目を有効にすると、 ユーザー/アクセス許可/コンピューター/グループ/スケジュール/セキュリティ関連の API を使用できます
- 有人サポート (Gateway v3.28.0 が必要) を有効にすると、 psa 関連の API を使用できます。
- 読み取り は、有効にすると、 GET API を使用できます。
- 書き込みは、有効にすると、 GET/PATCH/POST/PUT/DELETE APIを使用できます。
- 有効期限 (Gateway v3.28.0 が必要) で、API アプリケーションの有効期限を設定します。API アプリケーションの有効期限が切れると、この API アプリケーションから開始された API はブロックされます。
- ステータスで、API アプリケーションが Open API を使用できるようにします。
5. 「コピー」または「.txtとして保存」をクリックしてクライアント ID と クライアントシークレット を安全な場所に保存し、「OK」をクリックします。
APIの紹介
APIは認証に OAuth 2.0 と REST ベース を使用し、データ通信に JSONを使用します。
APIレート制限
各APIには、毎分200 回の呼び出しの制限があります。