PHP SDK
この PHP SDK を使うと、PHP から Transloadit の REST API を通じたファイルアップロードを自動化できます。
Composer でインストールできます。
インストール
composer require transloadit/php-sdk
Transloadit アカウントの Auth Key と Auth Secret を手元に用意してください。これらの値は API 認証情報ページで確認できます。
使い方
以下の PHP サンプルは、信頼できるサーバー側スクリプトで実行してください。Auth Secret はサーバー上で保持してください。ユーザーがアップロードを開始したり、Assembly の結果をリクエストしたりできるようにする前に、認可を行ってください。
1. サーバーから画像をアップロードしてリサイズ
このサンプルでは、SDK を使ってサーバー上で Assembly を作成する方法を示します。
サンプルの画像ファイルを Transloadit にアップロードし、リサイズ処理を開始します。
<?php
require 'vendor/autoload.php';
use transloadit\Transloadit;
$transloadit = new Transloadit([
'key' => 'YOUR_TRANSLOADIT_KEY',
'secret' => getenv('TRANSLOADIT_SECRET'),
]);
$response = $transloadit->createAssembly([
'files' => ['/PATH/TO/FILE.jpg'],
'params' => [
'steps' => [
'resize' => [
'robot' => '/image/resize',
'width' => 200,
'height' => 100,
],
],
],
]);
if ($response->error()) {
throw new \RuntimeException($response->data['error'] ?? 'REQUEST_FAILED');
}
// Show the results of the assembly we spawned
echo '<pre>';
print_r($response);
echo '</pre>';
2. エンドユーザー向けのシンプルなアップロードフォームの作成
ブラウザーからのアップロードには、以下の Uppy 連携を参照してください。署名処理はサーバー上で行い、ファイルはブラウザーから Transloadit に直接アップロードします。
処理完了の通知については、Webhooks API ドキュメントの署名検証の手順に従ってください。ブラウザーのリダイレクトは、Assembly の完了を証明するものではありません。Transloadit::response() は受信した通知データを解析しますが、認証は行いません。シークレットを指定して Transloadit のインスタンスを作成しても、その静的メソッドが Webhook を検証するようにはなりません。
3. Uppy によるファイルアップロード
ブラウザーからのアップロードには Uppy を推奨します。まずは Uppy と Transloadit の標準ガイドで、Template の設定、サーバー側での署名、フレームワーク別のクライアントサンプルを確認してください。
PHP バックエンドでは、有効期間の短い Assembly オプションに署名する前に、ユーザーの認証とアップロードの認可を行う必要があります。許可する Template と Assembly Instructions はサーバー上で選択してください。ブラウザーから送られた任意のパラメーターに署名しないでください。署名プロトコルについては Signature Authenticationを、完了通知の検証については前述の Webhook ドキュメントを参照してください。
4. Assembly Status JSON の取得
getAssembly メソッドを使うと、Assembly のステータスを取得できます。
<?php
require 'vendor/autoload.php';
use transloadit\Transloadit;
$assemblyId = 'YOUR_ASSEMBLY_ID';
$transloadit = new Transloadit([
'key' => 'YOUR_TRANSLOADIT_KEY',
'secret' => getenv('TRANSLOADIT_SECRET'),
]);
$response = $transloadit->getAssembly($assemblyId);
if ($response->error()) {
throw new \RuntimeException($response->data['error'] ?? 'REQUEST_FAILED');
}
echo '<pre>';
print_r($response);
echo '</pre>';
5. Template を使った Assembly の作成
このサンプルでは、SDK で Assembly を Template を使って作成する方法を示します。
事前に Transloadit アカウントのダッシュボードで Template を作成し、その Template ID をここに追加する必要があります。
<?php
require 'vendor/autoload.php';
use transloadit\Transloadit;
$transloadit = new Transloadit([
'key' => 'YOUR_TRANSLOADIT_KEY',
'secret' => getenv('TRANSLOADIT_SECRET'),
]);
$response = $transloadit->createAssembly([
'files' => ['/PATH/TO/FILE.jpg'],
'params' => [
'template_id' => 'YOUR_TEMPLATE_ID',
],
]);
if ($response->error()) {
throw new \RuntimeException($response->data['error'] ?? 'REQUEST_FAILED');
}
// Show the results of the assembly we spawned
echo '<pre>';
print_r($response);
echo '</pre>';
署名認証
PHP SDK は、Signature Authentication により、設定済みの Auth Secret を使って送信 API リクエストに署名します。受信する Webhook には、Webhook ドキュメントで説明しているとおり、別途署名検証が必要です。
サンプル
そのまま動作するサンプルは、examples/を参照してください。
ドキュメント
完全なドキュメントは GitHub を参照してください。