kintone APIドキュメント

プラグインを読み込む

目次

プラグインを読み込む

固定リンクがコピーされました

kintoneにプラグインを読み込ます。

URL

固定リンクがコピーされました

https://sample.cybozu.com/k/v1/plugin.json

HTTPメソッド

固定リンクがコピーされました

POST

必要なアクセス権

固定リンクがコピーされました

  • kintoneシステム管理者権限

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
fileKey 文字列 必須 ファイルをアップロードするAPIでアップロードしたプラグインファイルのファイルキー
ファイルをアップロードする
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

ボディ
1
2
3

{
  "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
id 文字列 読み込まれたプラグインのプラグインID
version 文字列 プラグインのバージョン
レスポンスの例
1
2
3
4

{
  "id": "djmhffjhfgmebgnmcggopedaofckljlj",
  "version": "1"
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト
1
2
3
4
5
6

curl -X POST 'https://sample.cybozu.com/k/v1/plugin.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
      "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5

const body = {
  fileKey: 'c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6'
};

await kintone.api(kintone.api.url('/k/v1/plugin.json'), 'POST', body);