- FTP接続機能の提供終了後もファイル管理ができるAPIについて
- ファイルのアップロード、ファイル名の変更、ディレクトリの新規作成などが可能
- 一定時間あたりの利用回数制限については、回数制限は設けていない(短時間に集中した利用は避ける)
概要
ライブドアブログでは、FTP接続機能の提供終了後も引き続きファイルのアップロード等が
利用できるように、File Manager APIをリリースしました。
本APIを使うことで、ブログ管理画面外からもブログのファイル管理を行うことができます。
機能一覧
File Manager APIでは、下記の機能を利用することができます。
1.ファイルのアップロード
2.ファイル名の変更
3.ディレクトリの新規作成
4.ファイル・ディレクトリ一覧情報の取得
5.ファイル・ディレクトリの削除
本ドキュメントを確認いただき、File Manager APIを是非ご活用ください。
パスワードの発行
File Manager APIでは、通常のログインとは別のパスワードを使用します。
ライブドアブログにログインし、「API Key」から「File Manager用パスワード」を
「(再)発行する」を選択し、パスワードを取得してください。
File Manager用パスワードは、ブログIDごとでひとつ割り当てられます。
パスワードは第三者に開示しないよう取り扱いには十分ご注意ください。
※「再発行する」を実行した場合は、以前のパスワードはすべて無効となります。
( BLOGNAMEの部分は各ブログのblognameが記載されます)
共通仕様
全てのリクエストはPOSTで実行してください。
リクエスト時に、HTTPリクエストヘッダにFile Manager用パスワードを「X-LDBlog-Token」
というキーでセットする必要があります。
リクエストパラメータが必要な場合は適宜追加してください。
各ルートエンドポイントに対して、HTTPメソッド（ POST ）でパラメータを送ることで
ファイルのアップロードやディレクトリの新規作成などの操作を行うことができます。
各ルートエンドポイントへは、必ず https で接続してください。
一定時間あたりの利用回数制限( Rate Limit )について、回数制限は設けていませんが
短時間に集中したご利用はご遠慮ください。
( 本APIは「Postman」や「Restlet Client」といったWebAPIテストツールからも
実行することができます。各ツールの利用方法については外部サイトを確認してください。)
ルートエンドポイント
ルートエンドポイントとは、API にアクセスするための固有のURIのことを指します。
本APIにおけるルートエンドポイントのベースURIは
https://livedoor.blogcms.jp/blog/ MY_BLOG_NAME /file_manager/ となっています。
file_manager/の後ろに、各ルートエンドポイントのパス( api_path )を記述してください。
( 例 /listの場合はhttps://livedoor.blogcms.jp/blog/ MY_BLOG_NAME /file_manager/list )
エラーの場合
上記のようなエラーメッセージが返却されます。
1. ファイルのアップロード /file_manager/upload
指定した場所にファイルをアップロードします。
リクエストパラメータ
①アップロードしたい場所のディレクトリIDを指定してください
※ディレクトリIDは「4.ファイル・ディレクトリ一覧情報の取得」から確認できます
②アップロードしたいファイルデータを選択してください
※アップロードできる1ファイルの容量は10MBまでです
※multipart/form-data 形式で POST してください
※nameパラメータが無い場合、ファイル名の決定にはupload_dataの
Content-Disposition filenameが使用されます
レスポンスパラメータ
なし
【POST】file_manager/upload の実行例
2. ファイル名の変更 /file_manager/rename
指定したファイル名を変更します。
※ディレクトリ名は変更できませんのでご注意ください。
リクエストパラメータ
①変更したいファイルのファイルIDを指定してください
※ファイルIDは「4.ファイル・ディレクトリ一覧情報の取得」から確認できます
②変更後のファイル名を入力してください
※ファイル拡張子まで指定してください
レスポンスパラメータ
なし
【POST】file_manager/rename の実行例
3. ディレクトリの新規作成 /file_manager/create_dir
指定した場所・階層にディレクトリを新規作成します。
リクエストパラメータ
①作成したい場所のディレクトリIDを指定してください
※指定がなければルートディレクトリが選択されます
②新規作成するディレクトリ名を入力してください
レスポンスパラメータ
なし
【POST】file_manager/create_dir の実行例
4. ファイル・ディレクトリ一覧情報の取得 /file_manager/list
ブログIDに紐づくファイル・ディレクトリの一覧を取得します。
リクエストパラメータ
①一覧情報を取得したいディレクトリIDを指定してください
※指定がなければルートディレクトリが選択されます
レスポンスパラメータ
リクエストに対して、下記の情報が返却されます
(※1) lists ・・・ファイル/ディレクトリの一覧情報
(※2) parents・・・親ディレクトリの一覧情報
dir_idが指定されていた場合は、指定されたdir_idの親ディレクトリが返却されます。
※ルートディレクトリは常にレスポンスされます。
【POST】file_manager/list の実行例
5. ファイル・ディレクトリの削除 /file_manager/remove
指定したファイルまたはディレクトリを削除します。
リクエストパラメータ
①削除したいファイルIDまたはディレクトリIDを指定してください
※各IDは「4.ファイル・ディレクトリ一覧情報の取得」から確認できます
レスポンスパラメータ
なし
【POST】file_manager/remove の実行例