概要
カスタム統合は、Workplaceを使用するお客様が、社内開発(または、単一のお客様のみを対象としたオーダーメイド開発)で、独自のツールやソフトウェアのエコシステムをWorkplaceに統合するために使用します。
このセクションでは、Workplaceのカスタム統合の作成と設定方法を説明します。
統合を作成する統合を作成する
統合を作成するには、会社の設定変更の権限と統合の設定権限をもつ管理者としてWorkplaceにログインする必要があります。ログインしたら、次のステップを実施して、統合を作成します。
統合を作成したら、設定に進んでいきます。
基本設定
管理者用パネルの[統合]セクションで、統合名をクリックして設定します。[統合]の詳細画面に表示されるフィールドを下に示します。
- [統合の詳細]: 統合の名前、ロゴ、説明の変更、アプリIDとApp Secretの表示、統合のアクセストークンの作成またはリセットが行えます。
アクセストークンはAPIリクエストの送信に必要です。Workplaceはこのトークンを基に、リクエストが統合から送信されたことを確認および検証します。アクセストークンは、ユーザーアカウントの作成または停止など、Workplaceでの重要なアクションを実行するのに使用できるため、安全な場所に保管することを強くおすすめします(ただし、重要なアクションを行うためには、必要なアクセス許可が統合に付与されている必要があります)。 - [可視化]: 統合を有効または無効にすることができます。無効にすると、統合はAPIリクエストを実行することができません。
また、統合がWorkplaceの利用可能なボットのリストに表示されるようにする公開設定を有効または無効にすることもできます。 - [前回のAPIリクエスト]: 統合がAPIリクエストを最後に実行した日と、過去7日間で実行したリクエスト数を表示することができます。
- [統合の削除]: 統合を削除することができます。この操作は後から取り消すことができず、統合とそれに関連するコンテンツが削除されます。
アクセス許可
統合の設定画面に[アクセス許可]というセクションがあります。ここで統合のアクセス許可を選択します。下記はアクセス許可のリストです。
カスタム統合のアクセス許可に関する詳細は、開発者向けドキュメントをご覧ください。
Webhooks
各統合で設定が可能なセクションとして、さらにWebhooksがあります。Webhooksを使用すると、特定のイベントをサブスクリプション登録して、リアルタイムで最新情報を受信することができます。Workplaceで変更が発生した場合、Webhookトピックにサブスクリプション登録している各カスタム統合アプリのコールバックURLに、HTTPS POSTリクエストが送信されます。
Webhookの一例として、投稿にコメントが作成された際に、コールバックURLでアップデートを受信できることが挙げられます。
トピック
Webhooksはトピックごとに分類されています。トピックごとに異なるコールバックURLを設定できます。利用できるトピックとサブスクリプションの詳細は、開発者向けドキュメントをご覧ください。
Webhookのサブスクリプション登録
Webhookのサブスクリプション登録とアクションの方法に関する詳細は、開発者向けドキュメントをご覧ください。
セキュリティ
統合用の設定の最後のセクションは、[セキュリティ]です。ここでは、2種類の設定ができます。
- サーバーIP許可リストを設定すると、リストに載っているIPアドレスから受け取るAPIコールのみを許可することができます。
- App Secret証明をオンにするを設定すると、セキュリティを強化するために、API呼び出しの際にApp Secretの詳細が求められるようになります。