cloudconvert php
3.4.2
Dies ist das offizielle PHP SDK für die CloudConvert API v2 .
Um das PHP SDK zu installieren, müssen Sie Composer in Ihrem Projekt verwenden.
Installieren Sie das SDK zusammen mit Guzzle:
composer require cloudconvert/cloudconvert-php guzzlehttp/guzzle Dieses Paket ist durch die Verwendung von PSR-7, PSR-17, PSR-18 und HTTPlug nicht an einen bestimmten HTTP-Client gebunden. Daher müssen Sie auch Pakete installieren, die psr/http-client-implementation und psr/http-factory-implementation bereitstellen (z. B. Guzzle).
use CloudConvert CloudConvert ;
use CloudConvert Models Job ;
use CloudConvert Models Task ;
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false
]);
$ job = ( new Job ())
-> setTag ( ' myjob-1 ' )
-> addTask (
( new Task ( ' import/url ' , ' import-my-file ' ))
-> set ( ' url ' , ' https://my-url ' )
)
-> addTask (
( new Task ( ' convert ' , ' convert-my-file ' ))
-> set ( ' input ' , ' import-my-file ' )
-> set ( ' output_format ' , ' pdf ' )
-> set ( ' some_other_option ' , ' value ' )
)
-> addTask (
( new Task ( ' export/url ' , ' export-my-file ' ))
-> set ( ' input ' , ' convert-my-file ' )
);
$ cloudconvert -> jobs ()-> create ( $ job )Sie können den CloudConvert Job Builder verwenden, um die verfügbaren Optionen für die verschiedenen Aufgabentypen anzuzeigen.
Uploads zu CloudConvert erfolgen über import/upload Aufgaben (siehe Dokumente). Dieses SDK bietet eine praktische Upload-Methode:
use CloudConvert Models Job ;
use CloudConvert Models Task ;
$ job = ( new Job ())
-> addTask ( new Task ( ' import/upload ' , ' upload-my-file ' ))
-> addTask (
( new Task ( ' convert ' , ' convert-my-file ' ))
-> set ( ' input ' , ' upload-my-file ' )
-> set ( ' output_format ' , ' pdf ' )
)
-> addTask (
( new Task ( ' export/url ' , ' export-my-file ' ))
-> set ( ' input ' , ' convert-my-file ' )
);
$ job = $ cloudconvert -> jobs ()-> create ( $ job );
$ uploadTask = $ job -> getTasks ()-> whereName ( ' upload-my-file ' )[ 0 ];
$ cloudconvert -> tasks ()-> upload ( $ uploadTask , fopen ( ' ./file.pdf ' , ' r ' ), ' file.pdf ' ); Die Methode upload() akzeptiert einen String, eine PHP-Ressource oder PSR-7 StreamInterface als zweiten Parameter.
Sie können Kunden auch direkt erlauben, Dateien auf CloudConvert hochzuladen:
< form action =" <?=$uploadTask->getResult()->form->url?> "
method =" POST "
enctype =" multipart/form-data " >
< ? foreach ((array)$uploadTask- > getResult()- > form- > parameters as $parameter = > $value) { ? >
< input type =" hidden " name =" <?=$parameter?> " value =" <?=$value?> " >
< ? } ? >
< input type =" file " name =" file " >
< input type =" submit " >
</ form > CloudConvert kann öffentliche URLs für die Verwendung von export/url -Aufgaben generieren. Sie können das PHP SDK verwenden, um die Ausgabedateien herunterzuladen, wenn der Job abgeschlossen ist.
$ cloudconvert -> jobs ()-> wait ( $ job ); // Wait for job completion
foreach ( $ job -> getExportUrls () as $ file ) {
$ source = $ cloudconvert -> getHttpTransport ()-> download ( $ file -> url )-> detach ();
$ dest = fopen ( ' output/ ' . $ file -> filename , ' w ' );
stream_copy_to_stream ( $ source , $ dest );
} Die Methode download() gibt ein PSR-7 StreamInterface zurück, das mit detach() als PHP-Ressource verwendet werden kann.
Webhooks können im CloudConvert Dashboard erstellt werden und dort finden Sie auch das erforderliche Signaturgeheimnis.
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false
]);
$ signingSecret = ' ... ' ; // You can find it in your webhook settings
$ payload = @ file_get_contents ( ' php://input ' );
$ signature = $ _SERVER [ ' HTTP_CLOUDCONVERT_SIGNATURE ' ];
try {
$ webhookEvent = $ cloudconvert -> webhookHandler ()-> constructEvent ( $ payload , $ signature , $ signingSecret );
} catch ( CloudConvert Exceptions UnexpectedDataException $ e ) {
// Invalid payload
http_response_code ( 400 );
exit ();
} catch ( CloudConvert Exceptions SignatureVerificationException $ e ) {
// Invalid signature
http_response_code ( 400 );
exit ();
}
$ job = $ webhookEvent -> getJob ();
$ job -> getTag (); // can be used to store an ID
$ exportTask = $ job -> getTasks ()
-> whereStatus ( Task :: STATUS_FINISHED ) // get the task with ' finished ' status . . .
-> whereName ( ' export-it ' )[ 0 ]; // ... and with the name 'export-it'
// ... Alternativ können Sie ein WebhookEvent mithilfe eines PSR-7 RequestInterface erstellen:
$ webhookEvent = $ cloudconvert -> webhookHandler ()-> constructEventFromRequest ( $ request , $ signingSecret );Signierte URLs ermöglichen die Konvertierung von Dateien bei Bedarf nur mithilfe von URL-Abfrageparametern. Das PHP SDK ermöglicht die Generierung solcher URLs. Daher müssen Sie eine signierte URL-Basis und ein Signaturgeheimnis im CloudConvert-Dashboard erhalten.
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false
]);
$ job = ( new Job ())
-> addTask (
( new Task ( ' import/url ' , ' import-my-file ' ))
-> set ( ' url ' , ' https://my.url/file.docx ' )
)
-> addTask (
( new Task ( ' convert ' , ' convert-my-file ' ))
-> set ( ' input ' , ' import-my-file ' )
-> set ( ' output_format ' , ' pdf ' )
)
-> addTask (
( new Task ( ' export/url ' , ' export-my-file ' ))
-> set ( ' input ' , ' convert-my-file ' )
);
$ signedUrlBase = ' SIGNED_URL_BASE ' ;
$ signingSecret = ' SIGNED_URL_SIGNING_SECRET ' ;
$ url = $ cloudConvert -> signedUrlBuilder ()-> createFromJob ( $ signedUrlBase , $ signingSecret , $ job , ' CACHE_KEY ' );Standardmäßig wird die Region in Ihren Kontoeinstellungen verwendet. Alternativ können Sie eine feste Region festlegen:
// Pass the region to the constructor
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false ,
' region ' => ' us-east '
]); vendor/bin/phpunit --testsuite unit
vendor/bin/phpunit --testsuite integration
Standardmäßig werden die Integrationstests für die Sandbox-API mit einem offiziellen CloudConvert-Konto ausgeführt. Wenn Sie Ihr eigenes Konto verwenden möchten, können Sie Ihren API-Schlüssel mithilfe der Umgebungsvariablen CLOUDCONVERT_API_KEY festlegen. In diesem Fall müssen Sie die folgenden MD5-Hashes für die Sandbox-API auf die Whitelist setzen (mithilfe des CloudConvert-Dashboards).
53d6fe6b688c31c565907c81de625046 input.pdf
99d4c165f77af02015aa647770286cf9 input.png
