全世界で 7 億人のユーザーを抱えるクラウドサービス Dropbox では、さまざまなアプリケーションやサービスと Dropbox API を通じて連携してお使いいただくことにより、より便利にご利用いただくことができます。このDropbox API について安全性・パフォーマンスを強化するために 2021 年 9 月 30 日より次の 2 点の変更が加えられます。
これらの変更により2021 年 9 月 30 日以降、Dropbox とアプリケーションまたはサービスとの新規連携できなくなったり、意図しない動作が生じる場合があります。
アプリケーション利用者の皆様は、アプリケーション開発者へ対応状況をご確認ください。アプリケーション開発者の皆様は、次の仕様変更詳細やマイグレーションガイドをご参照のうえ仕様確認や場合によってはコードの変更対応をお願いいたします。
仕様変更 1 : IDフォーマット
2021 年 9 月 30 日より、Dropbox API は新しい名前空間ID を String (pattern=”[-_0-9a-zA-Z:]+”) という形式の文字列で返すようになります。つまり、名前空間 ID には、文字(半角アルファベット大文字と小文字)、数字、記号「-」、「_」、「:」を含めることができます。
名前空間 ID は、フォルダの権限スペースを参照します。APIでは、共有フォルダ、チームフォルダ、ルートフォルダを参照するために使用されます。また、パスの引数にも使用されることがあります。ns_id、target_ns_id、previous_parent_ns_id、new_parent_ns_id、root、namespace_id、shared_folder_id、parent_shared_folder_id、team_folder_id、team_folder_ids、root_namespace_id、home_namespace_id、member_folder_id、nspath などのフィールド名が、この変更の影響を受けます。
Dropbox API の仕様では、これらのフィールドのデータ型は文字列となっていますが、実際に API から返される値は整数を文字列で表現したものでした。お客様のアプリケーションのコードやデータ ストレージがこの文字列パターンを処理できない場合に備えてお知らせします。アプリケーションがすでにこれらの値を整数ではなく文字列型として扱い、保存している場合は、何もする必要はありません。
仕様変更 2: トークンと権限
注意点として、2021 年 9 月 30 日に Dropbox の OAuth フローは新しい長期保存型のアクセストークンを返さなくなります。代わりに短命のアクセストークンが返され、オプションでリフレッシュトークンも返されるようになります。既存のトークンは影響を受けません。
バックグラウンドアクセスを必要とするアプリは、リフレッシュトークンを使用するようにコードを更新する必要がありますが、更新された SDK を使用することで容易になります。その他のアプリは、トークンの有効期限が切れた際にユーザーに再認証を促すようにしてください。
Dropbox API は、より詳細なパーミッション スコープをサポートしています。アプリケーションの OAuth フローを確認する際には、必要のないスコープがないかどうかを確認してください。
詳しい手順については、以下をご覧ください。
- Dropbox OAuth Guide
- ブログ記事 – Dropbox API：スコープ指定アプリと強化された認可フロー
- ブログ記事 – Dropbox API：アプリの権限とアクセス トークンの移行
Dropbox Platformのお知らせ
Dropbox プラットフォームに追加された最新の機能もぜひチェックしてみてください。Dropbox の開発者ブログでは、開発者向けの機能発表やチュートリアル、リソースなどをご覧いただけます。
たとえば、Dropbox Paper ドキュメントの作成と更新を可能にする API を最近更新しました。これらのペーパー ドキュメントは、ファイル API からアクセスできます。
ご不明な点がございましたら、開発者フォーラムをご覧いただくか、Dropbox API サポートへご連絡ください。
