Splashtopは現在、オープンAPIを提供し、ユーザーがワークフローを合理化し、サポート機能を
強化できるようになりました。
これらのRESTful API は、すべての Splashtop Enterprise チームで利用できます。
他のSplashtop製品を使用しているお客様は こちらからサインアップ してベータテストを
行うことができます。
ドキュメント
最新のオープンAPIリファレンスはこちらからダウンロードしてください。
Splashtop Open API リファレンス v0.9
APIで利用可能な機能
APIを使用すると、Splashtop Web管理コンソールで手動で実行していたタスクを自動化できます。
- ユーザー情報の取得（ユーザーリスト、アクセス権限）
- ユーザーの管理（ユーザーの招待、ユーザーの削除）
- コンピュータ情報の取得（コンピュータリスト、基本的なコンピュータ情報、インベントリ）
- コンピュータの管理（コンピュータの削除、コンピュータ名の変更、コンピュータグループの割り当て、コンピュータへのメモの追加）
- グループ管理（作成、編集、削除、ユーザー/コンピュータの割り当て）
- ログの取得（セッション、設定履歴、エンドポイント管理など）
Splashtopの有人サポートを統合するための API を使用すると、ServiceNow、Freshservice、
Jira Service Desk、Zendeskなどの すでに統合済みのサービス と同様のワークフローを作成できます。
- サポートセッションリンクの作成
- セッションを開始し、エンドユーザーのコンピュータに接続
- アーティファクト（セッションログ、ファイル転送ログ、チャット記録など）をチケットに書き戻す
今後もAPIに追加のサービスを提供していきます。
詳細については、今後の取り組み（ロードマップ） をご確認ください。
認証について
認証と認可には2つの方法が使用できます。
APIトークン（オーナーとポリシー設定や管理を許可された
スーパーアドミンのみ）
スーパーアドミンのみ）
- my.splashtop.com / my.splashtop.euからWeb管理コンソールにログインします。
- 「管理」⇒「設定」⇒ 「API」を選択します。
- 「API トークンの作成」をクリックします。
- APIトークンのスコープ と 有効期限 を設定します。
OAuth 2.0
- こちらのフォームを使用して、商用ソフトウエアまたは SplashtopアカウントにOAuth 2.0アプリを追加し、対応するクライアント ID と クライアントシークレットをお伝えください。また、 リダイレクトURLも提供する必要があります。
- my.splashtop.comもしくは my.splashtop.eu のWeb管理コンソールから 認証コードをリクエストします。リクエストする際には、以下のフォーマットを使用してください。
フォーマット
https://my.splashtop.com/oauth2/authorize?client_id=<client_id>&scope=<scope>&response_type=code&state=<string>&redirect_uri=<callback URL (urlencode)>
Parameters
client_id 作成したOAuthアプリのクライアントID（Splashtop提供） scope カンマで区切られた次のいずれかの値：
users、psa、service_desk、logs、team_users、team_computers、
team_groups,team_access_permission,inventorystate この変数を定義して、受信接続がユーザー側から開始された認証要求であることを確認します。後で、この状態を使用してアクセストークンを生成します。 redirect_uri URLエンコード形式のリダイレクトURL
- 認証コードを使用して、 アクセストークンと リフレッシュトークンに交換します。アクセストークンの有効期限は24時間で、リフレッシュトークンの有効期限は30日です。
詳細については、Splashtop オープンAPIリファレンスのセクション4.1 OAuth 2.0をご確認ください。