プロキシAPIの設定

GaroonのプロキシAPIの設定は、ポータルのHTMLポートレット、スケジュール、メッセージ、およびワークフローをJavaScriptでカスタマイズする場合に、必要に応じて利用する機能です。
プロキシAPIの設定を利用すると、カスタマイズに使用するJavaScriptから、外部サービスへのリクエストを送信できるようになります。
プロキシAPIの設定を利用しない場合のイメージ
プロキシAPIの設定を利用しない場合のイメージ Click to zoom this image
プロキシAPIの設定を利用する場合のイメージ
プロキシAPIの設定を利用する場合のイメージ Click to zoom this image

プロキシAPIの設定の前に確認すること

GaroonのプロキシAPIの設定は、カスタマイズに必要なJavaScriptファイルを準備したあとで行うことを推奨します。
Garoon全体の画面や、次のアプリケーションの画面をJavaScriptファイルを使ってカスタマイズできます。
  • ポータルのHTMLポートレット
  • スケジュール
  • メッセージ
  • ワークフロー
カスタマイズする前に、必ず注意事項を確認してください。
注意事項の詳細は、カスタマイズの前に確認することを参照してください。
注意
  • APIの仕様に関しては、製品サイトのサポートページのGaroon APIに関するお問い合わせフォームから、サイボウズのテクニカルサポートにお問い合わせください。
  • お客様自身でAPIを使ったJavaScriptなどのプログラム開発が困難な場合は、サイボウズ オフィシャルパートナーへご相談ください。
    パートナーは、製品サイトのパートナー 一覧で検索できます。
  • カスタマイズにより、Garoonの運用に支障が出た場合、サイボウズ側でカスタマイズ機能を一時的に無効にすることがあります。
    カスタマイズ機能を無効にした場合、「プロキシAPIの設定」画面に、次のエラーメッセージが表示されます。
    サイボウズの判断により、この機能は一時的に無効化されています。詳細はサイボウズまでお問い合わせください。

プロキシAPIの設定を追加する

GaroonにプロキシAPIの設定を登録します。
操作手順:
  1. カスタマイズに使用するJavaScriptでgaroon.base.proxy.send関数を呼び出します。
    パラメーターやリクエスト仕様、プロキシAPIの設定を利用したカスタマイズ例は、cybozu developer networkの【Garoon JavaScript API】ガルーンのスケジュールをkintoneに連携する方法を参照してください。
  1. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  1. [Garoonシステム管理]をクリックします。
  1. 「基本システムの管理」タブを選択します。
  1. [API]をクリックします。
  1. [プロキシAPIの設定]をクリックします。
  1. 「プロキシAPIの設定」画面で、[追加する]をクリックします。
    [追加する]が赤枠で囲まれた画像 Click to zoom this image
  1. 「プロキシAPI設定の追加」画面で、必要な項目を設定します。
    「ステータス」項目が有効であることを確認してから追加します。
  1. 設定内容を確認し、[追加する]をクリックします。
プロキシAPIの設定項目
項目 説明
ステータス 入力したプロキシAPIの設定を有効にするかどうかを選択します。
プロキシコード garoon.base.proxy.send関数を呼び出す際に利用するプロキシコードです。任意の文字列を指定できます。
関数で指定するコードと一致する必要があります。

コードは100文字まで入力できます。101文字以上入力した場合は、先頭から100文字までが登録されます。
登録済みのプロキシコードと重複している場合は、エラーが表示されます。
メソッド garoon.base.proxy.send関数を呼び出す際に利用するHTTPメソッドです。
関数で指定するメソッドと一致する必要があります。
メソッドの選択肢は次のとおりです。
  • GET
  • POST
  • PUT
  • DELETE
URL 実行するAPIのURLです。
関数で指定するURLと、前方一致する必要があります。
パラメーター 関数で指定した箇所に、登録したパラメーターの情報を付加します。
GETリクエストの際に、ここで設定したパラメーターを付加して送信できます。
ヘッダー 関数で指定した箇所に、登録したヘッダーの情報を付加します。
関数側とプロキシAPIの設定側で指定したヘッダーのキーが重複する場合は、プロキシAPIの設定側が優先されます。
プロキシAPIの設定で、ヘッダーのキーが重複する場合は、最後尾に指定したキーが優先されます。
ボディ 「メソッド」項目がPOSTまたはPUTの場合に表示される項目です。
ボディの情報が付加される条件は、cybozu developer networkの外部APIの実行を参照してください。

プロキシAPIの設定を変更する

登録済みのプロキシAPIの設定で、プロキシコードやパラメーターなどを変更します。
操作手順:
  1. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  1. [Garoonシステム管理]をクリックします。
  1. 「基本システムの管理」タブを選択します。
  1. [API]をクリックします。
  1. [プロキシAPIの設定]をクリックします。
  1. 変更するプロキシAPIのプロキシコードをクリックします。
  1. 「プロキシAPI設定の詳細」画面で、[変更する]をクリックします。
    [変更する]が赤枠で囲まれた画像 Click to zoom this image
  1. 「プロキシAPI設定の変更」画面で、必要な項目を編集します。
    必要に応じて、ステータスを無効に変更してから、設定内容を変更してください。
    項目の詳細は、プロキシAPIの設定項目を参照してください。
  1. 設定内容を確認し、[変更する]をクリックします。

プロキシAPIの設定を削除する

プロキシAPIの設定を削除します。
注意
  • 削除したプロキシAPIの設定は元に戻せません。
操作手順:
  1. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  1. [Garoonシステム管理]をクリックします。
  1. 「基本システムの管理」タブを選択します。
  1. [API]をクリックします。
  1. [プロキシAPIの設定]をクリックします。
  1. 「プロキシAPIの設定」画面で、削除するプロキシAPIの設定のチェックボックスを選択し、[削除する]をクリックします。
    削除するボタンが赤枠で囲まれた画像 Click to zoom this image
  1. 確認画面で、[はい]をクリックします。
補足
  • 次の手順でも、プロキシAPIの設定を削除できます。
    • 手順6で削除するプロキシAPIのプロキシコードを選択し、「プロキシAPI設定の詳細」画面で[削除する]をクリックする
ページトップへ戻る