Link Search Menu Expand Document

FAQ

開発者向けAPIについてのよくある質問です。kickflow自体についてのFAQはこちら

Table of contents

  1. チケットのJSONから、特定のフォームフィールドの入力を取得する方法を教えて下さい
  2. チケットの作成・更新時にファイルを添付することができますか?
  3. 任意の申請者になりすましてチケットを作成することはできますか?
  4. Personal Access TokenとService Account Tokenのどちらを使用すべきでしょうか?

チケットのJSONから、特定のフォームフィールドの入力を取得する方法を教えて下さい

ワークフローはkickflow内部でバージョン管理されているため、管理者がワークフローを編集する度に内部のフォームのidが変わります。 代わりに、codeというワークフローの編集をまたいで不変のキーが存在しておりますので、こちらを軸に入力を取得してください。

以下の手順で指定したフィールドの入力を取得できます。

  1. 対象のフォームフィールドのcodeから、フォームフィールドのidを取得します。
    • フォームフィールドのcodeはワークフローの管理画面やREST APIで確認できます。
  2. チケットの入力値の配列inputsから、formFieldIdが1で取得したidに一致するものを取得します。

チケットの作成・更新時にファイルを添付することができますか?

REST APIではファイルアップロードに対応しておりません。 代わりにBoxやOneDriveなどのファイルストレージにファイルをアップロードし、ファイルのURLをテキスト型の入力フィールドに入力してください。

任意の申請者になりすましてチケットを作成することはできますか?

Service Account Tokenを利用したAPI連携を実装することで可能です。 詳しくは REST APIの認証についてのセクション をご覧ください。

Personal Access TokenとService Account Tokenのどちらを使用すべきでしょうか?

原則として、どうしてもService Account Tokenを使用しないといけない場合を除いてPersonal Access Tokenの使用を優先してください。 Service Account TokenはPersonal Access Tokenに比べてアクセスできる範囲がはるかに大きいため、万が一トークンが漏洩したときに影響範囲が大きくなります。

Service Account Tokenを利用せざるを得ない例として、「外部サービスでユーザーが何らかの操作を行ったときに、自動的にkickflow内でそのユーザーがチケットを申請する」といった連携が挙げられます。 一方で、「組織図を定期的に同期する」「外部の取引先マスタをkickflowの汎用マスタに取り込む」といった連携では、Personal Access Tokenを使用するだけで実現可能です。

また、Personal Access Tokenを使用して外部と連携する場合でも、トークンを発行するユーザーアカウントには必要最低限の権限のみを付与することをおすすめします。 普段実際の社員が使うユーザーアカウントとは別に、連携に必要な権限のみを付与した連携専用のユーザーアカウントを用意することも検討してください。


Copyright © 2021 kickflow, Inc.