カスタムAPI呼び出し
このピースでできることkintone の接続方法1. 接続を作成2. 接続設定 - サブドメインを入力する3. 接続設定 - APIトークンを入力する4.接続設定 - アプリIDを入力する5.保存を押して接続名が設定されていることを確認するkintone接続時の注意点ピースの設定項目1. URL(必須)2. メソッド(必須)3. ヘッダー(任意)4. クエリパラメータ(任意)5. ボディ(任意)6. 失敗時にエラーにしない(任意)
このピースでできること
- kintoneのREST APIに対して、任意のリクエストを送信します。
- 標準で用意されたアクションにないAPIでも、このピースを使って呼び出せます。
kintone側でIPアドレス制限を設定している場合
workrunからのアクセスを許可するため、固定IPアドレスの登録が必要です。
kintone の接続方法
1. 接続を作成
- 接続から「接続を作成」をクリックします。

2. 接続設定 - サブドメインを入力する
- 「kintoneに接続」の画面に切り替わったら、必須項目を入力していきます。


- 「サブドメイン」はkintoneのURLから取得できます。

3. 接続設定 - APIトークンを入力する
- 「APIトークン」はアプリの管理者権限を保有するユーザーのみが確認できます。kintoneアプリ内の歯車マークの設定から「APIトークン」を選択してください。※画面上部にあるkintone側の設定メニューからは確認できないので、ご注意ください。



- APIトークンが未作成の場合は「生成する」をクリックすると、新規作成ができます。

- APIトークンのアクセス権を確認の上、保存を押してください。
- デフォルトのアクセス権は「レコード閲覧」のみが付与されています。レコードの追加や更新をおこなう場合は「レコード追加」「レコード編集」の権限を付与する必要があります。
- 誤削除を防ぐため「レコード削除」のアクセス権は外しておくことを推奨いたします。

- 「アプリを更新」をクリックして、変更した設定内容を反映させます。

- 生成されたAPIトークンを、workrunの「APIトークン」の欄に貼り付けてください。
4.接続設定 - アプリIDを入力する
- 接続したいkintoneアプリのIDを入力します。アプリを開き、URLの数字部分を入力してください。

5.保存を押して接続名が設定されていることを確認する

- 接続が成功すると、自動的にURL欄に入力されます。

kintone接続時の注意点
- APIトークンは、アプリの管理者権限を保有しているユーザーのみが確認・生成することができます。
- APIトークンのアクセス権で「レコードを削除」を有効にしていると、レコードが自動的に削除される可能性があります。誤作動を防ぐためにも、「レコードを」削除のアクセス権は無効化させておくことを推奨いたします。
- 1つの接続に設定できるAPIトークンは1つです。複数のkintoneアプリを参照するワークフローを作成する場合は、アプリごとに別の接続を作成し、それぞれのピースで使い分けてください。
ピースの設定項目
1. URL(必須)
- 完全なURL、またはベースURLからの相対パスを指定できます。
- ベースURLは接続情報のサブドメインから自動的に設定されます(例: )。
[設定例]
/k/v1/apps.json
2. メソッド(必須)
- HTTPメソッドを指定します(GET / POST / PUT / PATCH / DELETE)。
[設定例]
GET
3. ヘッダー(任意)
- 追加したいHTTPヘッダーをJSONで指定します。
- 認証ヘッダー(APIトークンやBasic認証)は接続情報から自動で付与されます。
[設定例]
{"Content-Type":"application/json"}
4. クエリパラメータ(任意)
- URLに付与するクエリパラメータをJSONで指定します。
[設定例]
{"limit":"10"}
5. ボディ(任意)
- リクエストボディをJSONで指定します(POST/PUT/PATCHなどで使用します)。
[設定例]
{"app":"1"}
6. 失敗時にエラーにしない(任意)
- 有効にすると、APIがエラーを返した場合でもワークフローを失敗扱いにせず継続します。
[設定例]
false