APIキーと連携
ツールに必要なアクセス権を持つ認証情報を作成します。
まずはこちらのガイドから
dosyaのファイルを扱うアプリケーションや自動化を構築するためのガイドです。APIキー、認証、RESTリクエスト、アップロード、ダウンロード、共有リンク、Webhook、レート制限、エラー、認証情報の安全な取り扱いについて説明します。各トピックでは、信頼性の高い連携に必要な設定と確認を中心に説明します。まずREST APIのクイックスタートから始め、権限を絞ったキーを作成してください。ファイルのアクティビティに応じてシステムを動かしたい場合は、Webhookを追加してください。
- APIアップロードの完了と確認 マルチパートの全セグメントをアップロードしてセッションを1回完了し、失われたレスポンスをステータスから復旧して、返されたファイルレコードを安全に確認します。
- APIでフォルダーを作成して親を確認する REST APIでフォルダーを1件作成し、再利用されたパスの各部分を正しく解釈して、返された子フォルダーが意図した親の直下にあることを確認します。
- REST APIのアップロードセッションを作成 正しい保存先、サイズ、スコープ、マルチパート設定でREST APIのアップロードを開始し、バイトを送信する前に返されたセッションを確認します。
- REST APIでファイルをダウンロードする 署名済みのRESTダウンロードURLを取得し、有効期間やファイルのバージョンを選び、バイトを取得して検証します。ロック、権限、使用量に関する問題にも対処します。
- REST APIのエラーとページ分割に対処する ファイルを飛ばさずにページ番号ごとの結果を処理し、dosya APIの失敗をステータスと本文で分類して、安全に繰り返せる操作だけを再試行します。
- APIファイルの取得不可と権限不足を区別する 無関係な識別子を調べたり非表示リソースを漏らしたりせず、権限不足を削除と誤認せずに、ファイルの404と403の応答を解釈します。
- REST APIでフォルダーを作成・移動 指定のRESTエンドポイントでフォルダーを作成、名前変更、移動します。名前を保持し、ツリーの競合を避けながら、最終的な親フォルダーを確認します。
- APIで識別子からファイルのメタデータを取得 識別子からファイルレコードを1件取得し、返されたメタデータの各フィールドとnull値を解釈します。ファイルが存在しない場合と、非表示、ロック、アクセス拒否の応答を区別します。
- APIキーの作成と管理 プロフィールでキーを生成し、権限と制限を選んで、表示中に保存します。後でキーを交換または失効できます。
- 期限が近いAPIキーのローテーション 期限が近いキーの複製できる設定をコピーし、省略された制限と有効期限を再設定して交換用キーを検証します。その後、停止時間を設けずに古いシークレットを無効化します。