iOS と Transloadit
Template、TransloaditKit 3.5.0、アプリの認証済みバックエンドとの署名連携を使って、iOS からアップロードを作成します。
実行可能な処理設定
連携を構築
この Swift ヘルパーは、一つの Template から Assembly を作成し、ローカルファイルをアップロードキューに追加して、そのステータスをポーリングします。アプリ側では、TransloaditKit ガイドに記載された認証付き署名の連携を実装します。
- Swift Package Manager または CocoaPods で、TransloaditKit のバージョンを必ず 3.5.0 に指定してインストールしてください。Swift Package Manager では TUSKit が 3.6.0 に固定されます。解決済みの依存関係のバージョンをプロジェクトとともに保存してください。
- サーバー側で管理する Template を作成し、Step のオーバーライドを無効にして、Signature Authentication を必須にしてください。TransloaditKit の署名・利用ガイドに従い、意図したワークフローのみを許可するようにバックエンドを設定してください。
- Auth Key、Template ID、ローカルファイルパスのプレースホルダーを置き換えてから、アプリの同期 SignatureGenerator と completion および statusChanged のハンドラーを指定して createAssembly を呼び出してください。
- メインスレッド以外で createAssembly を呼び出し、処理中は返された Transloadit クライアントを保持してください。UI の更新はメインキューにディスパッチしてください。両方のコールバックでエラーを処理してください。
Upload.swift
// Swift Package Manager:
// .package(url: "https://github.com/transloadit/TransloaditKit", exact: "3.5.0")
// Or CocoaPods: pod 'Transloadit', '3.5.0'
// Pin its dependency too: pod 'TUSKit', '3.6.0'
import Foundation
#if canImport(TransloaditKit)
import TransloaditKit
#else
import Transloadit
#endif
// TransloaditKit 3.5.0. Supply your app’s authenticated signing integration.
// Its backend must authorize params, expiry, processing and destination policy,
// then sign the exact original UTF-8 bytes. Do not reserialize them.
// The signing completion is nonescaping: call it synchronously exactly once
// before the signature generator returns, including denial and timeout.
// Use synchronous transport with a finite timeout, off the main thread.
// The SDK fixes a 24-hour expiry; use backend creation if policy requires less.
// Retain the returned client for the operation’s lifetime.
// Signing guide: https://transloadit.com/docs/sdks/transloaditkit/#user-content-transloaditkit-usage
func createAssembly(
signatureGenerator: @escaping SignatureGenerator,
configuration: URLSessionConfiguration = .default,
completion: @escaping (Result<Assembly, TransloaditError>) -> Void,
statusChanged: @escaping (Result<AssemblyStatus, TransloaditError>) -> Void
) -> Transloadit {
let transloadit = Transloadit(
apiKey: "YOUR_TRANSLOADIT_KEY",
sessionConfiguration: configuration,
signatureGenerator: signatureGenerator
)
// Replace these paths with local file URLs from your app.
let filesToUpload: [URL] = [
URL(fileURLWithPath: "/path/to/file.jpg"),
]
transloadit.createAssembly(templateId: "YOUR_TRANSLOADIT_TEMPLATE_ID", andUpload: filesToUpload, completion: completion)
.pollAssemblyStatus(completion: statusChanged)
return transloadit
}
認証
- 公開用の Auth Key と、アプリの認証済み SignatureGenerator をヘルパーに渡してください。Auth Secret はバックエンドに保持し、Workspace または Template で Signature Authentication を必須にしてください。
- バックエンドでは、元の UTF-8 params バイト列に署名する前に、ユーザーを認証し、使用する Auth Key、Template、フィールド、処理、送信先、有効期限を個別に承認する必要があります。余分な Step や未知のオプションは拒否してください。template_id の一致だけでは不十分です。
- TransloaditKit 3.5.0 は、非エスケープの署名完了コールバックを使用します。拒否やタイムアウトの場合も含め、SignatureGenerator が戻る前に必ず一度だけ呼び出してください。メインスレッド以外で、有限のタイムアウトを設定した同期通信を使用してください。
制限事項と運用上の注意点
- SDK は auth.expires を 24 時間に固定しており、署名コールバックではパラメーターを置き換えられません。ポリシーでこれより短い有効期限が必要な場合は、リクエストを拒否し、バックエンドで Assembly を作成してください。
- このヘルパーは、単一の Template とローカルファイルを対象としています。TransloaditKit 3.5.0 では、Template と Step のオーバーライドを組み合わせたり、任意の Assembly オプションや認証オプションを設定したりできません。これらの制御が必要な場合は、バックエンドで Assembly を作成してください。
- create コールバックは、Assembly が存在し、アップロードがスケジュールされたことを示します。ファイルのアップロードや処理の完了を意味するものではありません。
- SDK の想定ファイル数は署名対象のパラメーターに含まれず、認可上の上限ではありません。サーバーが管理するワークフローで、クォータとファイルの制限を適用してください。Template で要件を強制できない場合は、バックエンドで Assembly を作成してください。
- このヘルパーには、アプリのログイン機能と署名用の通信処理が必要です。バックグラウンドでのスケジュール実行、再開機能、ライフサイクル処理、ファイルアクセスは、対象デバイスでの組み込みとテストが必要です。
その他の連携