ヌーラボBacklogの共有ファイルをcurlでダウンロードする

基本

https://<spaceKey>.backlog.jp/というURLを頭に付けて、各APIのURLを叩きます。

例えば、スペース情報を取得するならURLはこんな感じ。

https://<spacekey>.backlog.jp/api/v2/space?apiKey=***

上記にあるようにAPIを叩くにはkeyが必要です。これは、個人設定➡️APIから発行しておきます。

***をkeyに書き換えてこんな感じにするとデータを取得できると思います。

curl 'https://<スペースID>.backlog.jp/api/v2/space?apiKey=***'

response.json

{
  "spaceKey": "spaceKey",
  "name": "...",
  "ownerId": ...,
  "lang": "ja",
  "timezone": "Asia/Tokyo",
  "reportSendTime": "06:00:00",
  "textFormattingRule": "markdown",
  "created": "2000-01-01T00:00:00Z",
  "updated": "2000-01-01T00:00:00Z"
}

ファイルIDを取得

共有ファイルのダウンロードに載ってるようにファイルを取得するには、sharedFileIdというのが必要です。

/api/v2/projects/:projectIdOrKey/files/:sharedFileId 

それは共有ファイル一覧の取得で調べることができます。

/api/v2/projects/:projectIdOrKey/files/metadata/:path 

例えばci/というディレクトリの中身を取得したい場合は、こんな感じで叩きます。

（ちなみに<projectkey>というのは、プロジェクトのホームを開いたときのURLの一番最後の文字列やつを指定すれば大丈夫です。https://<spacekey>.backlog.jp/projects/hogeだったらhoge）

curl 'https://<spacekey>.backlog.jp/api/v2/projects/<projectkey>/files/metadata/ci?apiKey=***'

だいたいこんな感じで配列で返ってきます。例えばa.txtをダウンロードしたい場合、sharedFileIdは999999...になります。

response.json

[
  {
    "id": 999999...,
    "type": "file",
    "dir": "/ci/",
    "name": "a.txt",
    "size": 10000,
    "createdUser": {...},
    "created": "2000-01-01T00:00:00Z",
    "updatedUser": null,
    "updated": "2000-01-01T00:00:00Z"
  }
]

ファイルダウンロード

では取得したIDを埋め込んで叩くだけです。ファイルへ保存する-Oフラグを忘れないように！

curl -o a.txt -O 'https://<spacekey>.backlog.jp/api/v2/projects/<projectkey>/files/999999...?apiKey=***'    

あと、-oフラグを付けて保存しないと999999...?apiKey=***みたいなファイル名になっちゃうので、付けると良いと思います。