<< Click to Display Table of Contents >> Navigation:  »No topics above this level« API V3 マニュアル

こちらではFileBlog API Version3 についてご説明いたします。

FileBlog API とは

FileBlog Version3.9.0以降、ファイル操作などの一部の機能をAPIとして公開しています。

FileBlog APIはHTTPプロトコルを介して呼び出せるので、ユーザーはOSや端末を問わず独自のアプリケーションを簡単に構築することができます。

※FileBlog API を利用するには別途ライセンスを購入する必要があります。

また、このAPIマニュアルにない機能をお求めの場合は弊社サポートまでご相談ください。

API呼び出しの基本

APIはFileBlogサーバが稼働しているホストマシンに対して、以下のようなURLでHTTPリクエストを送信することで実行します。

http(s)://<ホスト名>/fileblog/api/v3/<APIグループ名>/<API名>

例

http://<ホスト名>/fileblog/api/v3/files/list_folder

各APIはいくつかの例外を除きHTTPヘッダに以下の2つのフィールドを含める必要があります。

リクエストとレスポンスのデータは共にJSON（JavaScript Object Notation）形式で文字コードはUTF8を使用します。

API呼び出しの流れ

各APIは実行前にFileBlogにログインして、アクセストークンを取得しておく必要があります。

以下のサンプルでは、ログイン(/auth/login)を実行し、取得したアクセストークンを使ってファイル一覧(/files/list_folder)を実行する流れをご説明します。

ログイン

ログインしてアクセストークンを取得します。

リクエスト

POST http://<ホスト名>/fileblog/api/v3/auth/login
Content-Type: application/json; charset=utf-8
 
{
 userid:"test",
 password:"pass",
 domain:"fileblog"
}

レスポンス

HTTP/1.1 200 OK
{
　　"access_token": "CA4C1E2219374643ACBA8B4BEE12319F"
}

access_tokenに<アクセストークン>が格納されています。

ファイル一覧

取得したaccess_tokenを使用して/files/list_folderを実行します。

リクエスト

POST http://<ホスト名>/fileblog/api/v3/files/list_folder
Authorization: Bearer CA4C1E2219374643ACBA8B4BEE12319F
Content-Type: application/json; charset=utf-8
 
{
 path:"/"
}

レスポンス

HTTP/1.1 200 OK
{
 "entries":[
         {
                 "name": "DocRoot",
                 "path": "/DocRoot",
                 "creationtime": "2000-01-01T00:00:00.000Z",
                 "lastwritetime": "2000-01-01T00:00:00.000Z",
                 "is_dir": true,
                 "size": -1
         }
 ]
}

/（トップ)フォルダ内のファイル、フォルダ一覧が取得できました。