【悩み】
・DropBoxのAPIを使ってみたいけど登録や申請などは必要？
・DropBoxのAPIを使いたい！必要な手続きや準備を詳しく知りたい。
・そもそもDropBoxのAPIって何？どういう場面で使うべき？
こういった悩みにお答えします。
【この記事の内容】
① そもそもDropBoxのAPIとは？
➁ DropBoxのAPIの申請手順
➂ よくある質問(FAQ)
記事の前半では「そもそもDropBoxのAPIとは何か？」「DropBoxのAPIの申請手順」を解説します。
記事の後半では、「DropBoxのAPIの申請周りでよくある質問や疑問」をご紹介します。
この記事を読み終えることで、「DropBoxのAPIとは何かを理解した上で、DropBoxのAPIの申請ができる」状態になります。
そもそもDropBoxのAPIとは？
以下の順番で、DropBoxのAPIとはどういったものなのか？に関してご紹介します。
【ご紹介事項】
・DropBoxのAPIとは？何ができる？
・どのような場面で利用する？
・使う際の注意点
DropBoxのAPIとは？何ができる？
DropBox APIとは、「インターネット上にファイルを保存・共有できるクラウドストレージサービスであるDropBox」のファイルアップロードなどの操作をウェブブラウザを介さずに取得できるサービスのことです。
こちらの公式サイトに記載されていますが、DropBoxのAPIの主な機能としては、以下が挙げられます。
| 機能名 | できること | 取得できる情報一覧 |
| 検索 | DropBoxに対して検索し、該当するファイルやフォルダの情報を取得できます。 | こちらの公式サイト参照 |
| ファイル操作 | ファイルのアップロードや削除といった操作ができます。 | こちらの公式サイト参照 |
| フォルダ操作 | フォルダの作成や削除といった操作ができます。 | こちらの公式サイト参照 |
| シェア操作 | ファイルやフォルダを公開するための公開リンクを取得できます。 | こちらの公式サイト参照 |
どのような場面で利用する？
DropBoxのAPIは、以下の場面でよく利用されます。
| 利用場面 | 利用目的 | 活用例 |
| 業務システムとの自動連携 | ファイル管理の自動化 | 自動作成された請求書や帳票を、Dropboxの指定フォルダへAPI経由で保存・整理する。 |
| バックアップ | 重要データの保存 | サーバーやローカルPCのログ・成果物を定期的にDropboxへ自動アップロードする。 |
| コンテンツ配信や共有の効率化 | 外部ユーザーとのファイル共有 | 動画や資料をDropboxに保存し、APIで共有リンクを発行して会員サイトやアプリに組み込む。 |
使う際の注意点
DropBox APIの利用規約を遵守した上で使いましょう。以下に、利用規約を要約したものを掲載いたします。
・共有フォルダ、グループ、チームフォルダのメンバー上限は最大1,000人
・制限付きフォルダのメンバー上限は250人
・一度に招待できる人数は最大1,000人
・1フォルダ内で共有できるサブフォルダは最大1,500個
・アカウント全体の共有フォルダ数は最大30,000個
・24時間あたりの書き込み操作（作成・変更など）は最大100万件
・1ユーザーが同期するファイル数は30万個以下を推奨
・同期する共有、チームフォルダ数は1,000個以下を推奨
・大量の移動やリネーム操作はWebよりデスクトップアプリ推奨
・フォルダ構造が複雑だと権限変更に時間がかかる場合あり
・チーム人数自体の上限はないが、ユーザーごとにライセンスが必要
・アップロードサイズ上限
・デスクトップ／モバイル：2TB未満
・Web：50GB未満
・API：350GB未満
・共有リンク帯域幅
・Standard：1TB/日
・Advanced / Enterprise：4TB/日
・APIのアップロード操作は月10億回まで
また、DropBox APIを使いたい場合、DropBoxの運営元に対して申請手続きを行う必要があります。ちなみに、申請に対する承認審査といったものは存在しません。
そのため、申請手続きさえすれば、どなたでもDropBox APIを利用できます。
以上が、DropBoxのAPIに関する簡単な概要となります。以降では、DropBox APIの申請手順を図を用いながらなるべく分かりやすくご紹介します。
DropBox APIの申請手順【7手順・最短10分で利用可能】
今までご紹介し続けてきた「DropBox API」の申請手順を、以下の順番で説明します。
【流れ】
全体像：DropBox APIを使うまでの流れ
手順１：DropBox無料会員登録
手順２：appsを作成
手順３：appsの権限を変更
手順４：アクセストークンを生成
手順５：アクセスコードを作成
手順６：リフレッシュトークンを取得
手順７：DropBox APIの動作確認
全体像：DropBox APIを使うまでの流れ
DropBox APIを使うまでの流れを以下の図および表に記載します。
DropBox APIを利用するには、簡単な設定が必要な申請手続きを行う必要があります。
| 工程 | 概要 | 備考 |
| 手順１：DropBox無料会員登録 | DropBoxの会員登録を実施 | 「メールアドレス」が必要 |
| 手順２：appsを作成 | DropBox APIを使うために追加で情報の登録を実施 | 審査なし(即時作成可能) |
| 手順３：appsの権限を変更 | DropBox APIで操作できる範囲の決定 | – |
| 手順４：アクセストークンを生成 | ボタンを１回クリックするだけで作成可能 | アクセストークンには有効期限があるため、後述のリフレッシュトークンの取得を推奨 |
| 手順５：アクセスコードを作成 | 指定URLにアクセスすることで取得 | リフレッシュトークンの作成に必要 |
| 手順６：リフレッシュトークンを取得 | コマンドプロンプトからURLにアクセスし取得 | – |
| 手順７：DropBox APIの動作確認 | DropBox APIが正しく動作することを確認 | – |
DropBox無料会員登録
DropBox APIを使うためには、DropBoxの会員になる必要があります。以下のURLにアクセスし、無料の会員登録を実施してください。
手順２：appsを作成
DropBoxにログイン後、以下のURLにアクセスします。
アクセス後、「Create app」をクリックしてください(下図の赤枠部分)。
クリック後、「App folderまたはFull Dropboxを選択」「appの名称入力」「同意書にチェック付与」した後に「Create app」をクリックします。
App forderを選択した場合は、DropBoxにApp専用のフォルダが自動作成され、そのフォルダしか操作できなくなります。
一方、Full Dropboxを選択した場合、DropBoxの全フォルダを操作できるようになります。
手順３：appsの権限を変更
先ほどの操作後、作成したappの画面が表示されます。表示された画面内の「Permissions」をクリックします。
クリック後、「files.content.write」「files.content.read」「sharing.write」にチェックを付与します。
付与しなかった場合、「ファイルとフォルダの読み取りや書き込み」「ファイルやフォルダに対する公開リンクの作成」をAPI経由でできなくなります。
その後、ページ末尾にポップアップされる「Submit」ボタンをクリックし、変更を反映してください。
手順４：アクセストークンを生成
続いてはアクセストークンを生成するために、「Settings」をクリックします。
クリック後、「Generate」ボタンを押すことで、アクセストークンを作成できます。
作成したアクセストークンの有効期限は約40時間です。長期的にDropBoxのAPIを利用したい場合は、以降でご紹介するリフレッシュトークンの取得をオススメします。
手順６：リフレッシュトークンを取得
DropBoxのAPIを長期的に使いたい場合、リフレッシュトークンを取得しましょう。
まずは、「手順２：appsを作成」で作成したappの「App key」と「App secret」を確認します。「App key」と「App secret」は、先ほどの手順でクリックした「Generate」ボタンの少し上に記載されています。
確認した「App key」と「App secret」を用いた下記のURLにアクセスしてください。
【アクセスするURL】
https://www.dropbox.com/oauth2/authorize?client_id=確認したApp key&token_access_type=offline&response_type=code
アクセス後、「続行＞許可」をクリックし、アクセスコードを取得してください。
アクセスコード取得後、コマンドプロンプトを起動し、下記のコマンドを実行しましょう。
【実行コマンド】
curl -X POST https://api.dropboxapi.com/oauth2/token -u “App keyを記載:App secretを記載” -H “Content-Type: application/x-www-form-urlencoded” -d “grant_type=authorization_code&code=アクセスコードを記載”
コマンドを実行することで、下図の赤枠部分のようにリフレッシュトークンを取得できます。
手順７：DropBox APIの動作確認
最後に、DropBox APIの動作確認をしましょう。
動作確認するためには、URLを作る必要があります。以下のリファレンスを参照し、URLを作成してみてください。
本記事では、動作確認URLとして以下を使います。＜＞の部分は、ご自身の情報を設定してください。
curl -X POST https://api.dropboxapi.com/2/check/user --header "Authorization: Bearer ＜アクセストークンを記載＞" --header "Content-Type: application/json" --data "{\"limit\":1000}"
その後、コマンドプロンプトを起動し、動作確認URLを入力した上でEnterを押下しましょう。
押下後、下図のように「{“result”:””}」が表示された場合、正常にDropBox APIが動作したと判断できます。
以上が、DropBox APIの申請手順となります。以降では、DropBox APIの申請に対するよくある質問や疑問に関して回答します。
よくある質問(FAQ)
DropBox API申請手順に関して様々な疑問があるかと思います。ここでは、以下の「よくある質問」や「疑問」に対して解説します。
【よくある質問や疑問の一覧】
・作成したアクセストークンを再確認できる？
・DropBox APIは無料？料金は発生しない？
作成したアクセストークンを再確認できる？
以下のURLにアクセスすることで、作成したアクセストークンを再確認できます。
DropBox APIは無料？料金は発生しない？
はい、本記事執筆時点では「無料」で利用できます。
ただし、運営元の方針転換があった場合、有料になる可能性もあります。
いかがだったでしょうか？不安は解消できましたか？
不安が解消されましたら、先ほどご紹介した申請手順に従いながら、DropBox APIを申請してみましょう！
【まとめ】DropBox APIの登録は簡単！10分で可能！
いかがでしたでしょうか？
上記でご紹介した手順を実践することで、DropBox APIを申請でき、DropBox API経由でファイルのアップロードや公開リンクの取得ができます。
最後にもう一度内容を確認しましょう。
【おさらい】
・DropBox APIとはブラウザなしでDropBoxを操作できるサービスのこと
・ご紹介した7つの手順によりDropBox API使うことができる！
・DropBox APIは審査不要で即利用可能！さらに無料！
本ブログでは、「様々な作業を自動化するために必要なプログラミング」や「業務の時短化に繋がるIT技術」などを発信しています。定期的に更新していますので、ぜひブックマークをよろしくお願いいたします。
>> IT技術やその学び方を発信しているサイト「駆け出し物語」(本ブログ)
コメント