kintone API ドキュメント

プラグインを追加する

目次

caution
警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効／無効の切り替え手順 (External link) を参照してください。

API に関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • APIラボで提供されているAPIを早く本番環境で利用したい
  • こういう用途で使うために、このようなAPIを提供してほしい

プラグインを追加する

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

kintoneシステム管理にプラグインを追加します。

利用するには開発中の新機能の「プラグインの読み込み、更新、削除をするREST API」を有効にしてください。

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
レスポンスの例
1
2
3

{
  "id": "djmhffjhfgmebgnmcggopedaofckljlj"
}