プロキシAPIの設定

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

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

GaroonのプロキシAPIの設定は、カスタマイズに必要なJavaScriptファイルを準備したあとで行うことを推奨します。
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に連携する方法を参照してください。
  2. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  3. [Garoonシステム管理]をクリックします。
  4. 「基本システムの管理」タブを選択します。
  5. [API]をクリックします。
  6. [プロキシAPIの設定]をクリックします。
  7. 「プロキシAPIの設定」画面で、[追加する]をクリックします。
    追加するリンクが赤枠で囲まれている画像
  8. 「プロキシAPI設定の追加」画面で、「プロキシコード」項目を入力します。
    プロキシコードは必ず設定します。
    garoon.base.proxy.send 関数を呼び出す際に利用するプロキシコードです。関数で指定するコードと一致する必要があります。
    プロキシコードは100文字まで入力できます。101文字以上入力した場合は、先頭から100文字までが登録されます。
    登録済みのプロキシコードと重複している場合、エラーが表示されます。
    プロキシコードを入力している画像
  9. 「メソッド」項目を設定します。
    garoon.base.proxy.send関数を呼び出す際に利用するHTTPメソッドです。関数で指定するメソッドと一致する必要があります。
    設定できるメソッドは、次のとおりです。
    • GET
    • POST
    • PUT
    • DELETE
    メソッド項目を設定している画像
  10. 「URL」項目を入力します。
    URLは必ず設定します。
    実行するAPIのURLを入力します。URLは、関数で指定するURLと前方一致する必要があります。
    URLを入力している画像
  11. 「パラメーター」項目を設定します。
    関数で指定した箇所に、登録したパラメーターの情報を付加します。
    GETリクエストの際に、ここで設定したパラメーターを付加して送信できます。
  12. 「ヘッダー」項目を設定します。
    関数で指定した箇所に、登録したヘッダーの情報を付加します。
    関数側とプロキシAPIの設定側で指定したヘッダーのキーが重複する場合は、プロキシAPIの設定側が優先されます。
    プロキシAPIの設定で、ヘッダーのキーが重複する場合は、最後尾に指定したキーが優先されます。
  13. 「ボディ」項目を設定します。
    「メソッド」項目がPOSTまたはPUTの場合に表示される項目です。
    ボディの情報が付加される条件は、cybozu developer networkの外部APIの実行を参照してください。
  14. 「ステータス」項目で、「有効」を選択します。
    有効のラジオボタンを選択している画像
  15. 設定内容を確認し、[追加する]をクリックします。

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

プロキシAPIの設定内容を変更します。
操作手順:
  1. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  2. [Garoonシステム管理]をクリックします。
  3. 「基本システムの管理」タブを選択します。
  4. [API]をクリックします。
  5. [プロキシAPIの設定]をクリックします。
  6. 「プロキシAPIの設定」画面で、変更するプロキシAPIのプロキシコードをクリックします。
  7. 「プロキシAPI設定の詳細」画面で、[変更する]をクリックします。
    変更するリンクが赤枠で囲まれている画像
  8. 「プロキシAPI設定の変更」画面で、必要に応じて設定を変更します。
  9. 設定内容を確認し、[変更する]をクリックします。

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

プロキシAPIの設定を削除します。
注意
  • 削除したプロキシAPIの設定は元に戻せません。

1件ずつプロキシAPIの設定を削除する

1件ずつプロキシAPIの設定を削除します。
操作手順:
  1. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  2. [Garoonシステム管理]をクリックします。
  3. 「基本システムの管理」タブを選択します。
  4. [API]をクリックします。
  5. [プロキシAPIの設定]をクリックします。
  6. 「プロキシAPIの設定」画面で、削除するプロキシAPIのプロキシコードを選択します。
  7. 「プロキシAPI設定の詳細」画面で、[削除する]をクリックします。
    削除するリンクが赤枠で囲まれている画像
  8. 「プロキシAPI設定の削除」画面で、[はい]をクリックします。

複数のプロキシAPI の設定をまとめて削除する

削除するプロキシAPIの設定を選択して、まとめて削除します。
操作手順:
  1. ヘッダーの歯車の形をした管理者メニューアイコンをクリックします。
  2. [システム設定]をクリックします。
  3. 「基本システムの管理」タブを選択します。
  4. [API]をクリックします。
  5. [プロキシAPIの設定]をクリックします。
  6. 「プロキシAPIの設定」画面で、削除するプロキシAPIのチェックボックスを選択し、[削除する]をクリックします。
    削除するプロキシAPIの設定を選択している画像
  7. 「プロキシAPI設定の一括削除」画面で、[はい]をクリックします。