cloudconvert php

CloudConvert-php

Это официальный PHP SDK для CloudConvert API v2 .

Установить

Чтобы установить PHP SDK, вам нужно будет использовать Composer в своем проекте.

Установите SDK вместе с Guzzle:

composer require cloudconvert/cloudconvert-php guzzlehttp/guzzle

Этот пакет не привязан к какому-либо конкретному HTTP-клиенту с помощью PSR-7, PSR-17, PSR-18 и HTTPlug. Поэтому вам также потребуется установить пакеты, обеспечивающие psr/http-client-implementation и psr/http-factory-implementation (например, 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 )

Вы можете использовать CloudConvert Job Builder, чтобы просмотреть доступные параметры для различных типов задач.

Загрузка файлов

Загрузка в CloudConvert осуществляется с помощью задач import/upload (см. документацию). Этот SDK предлагает удобный метод загрузки:

 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 ' );

Метод upload() принимает строку, ресурс PHP или StreamInterface PSR-7 в качестве второго параметра.

Вы также можете напрямую разрешить клиентам загружать файлы в CloudConvert:

 < 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 может генерировать общедоступные URL-адреса для использования задач export/url . Вы можете использовать PHP SDK для загрузки выходных файлов после завершения задания.

 $ 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 );

}

Метод download() возвращает StreamInterface PSR-7, который можно использовать в качестве ресурса PHP с помощью detach() .

Вебхуки

Веб-перехватчики можно создавать на панели управления CloudConvert, и там же можно найти необходимый секрет подписи.

 $ 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'
// ...

Альтернативно вы можете создать WebhookEvent используя RequestInterface PSR-7:

 $ webhookEvent = $ cloudconvert -> webhookHandler ()-> constructEventFromRequest ( $ request , $ signingSecret );

Подписанные URL-адреса

Подписанные URL-адреса позволяют конвертировать файлы по требованию только с использованием параметров запроса URL-адреса. PHP SDK позволяет генерировать такие URL-адреса. Поэтому вам необходимо получить подписанную базу URL-адресов и секрет подписи на панели управления CloudConvert.

 $ 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 ' );

Установка региона

По умолчанию используется регион в настройках вашего аккаунта. Альтернативно вы можете установить фиксированный регион:

 // 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

По умолчанию при этом выполняются интеграционные тесты API Sandbox с официальной учетной записью CloudConvert. Если вы хотите использовать свою собственную учетную запись, вы можете установить свой ключ API, используя переменную среды CLOUDCONVERT_API_KEY . В этом случае вам необходимо внести в белый список следующие хэши MD5 для Sandbox API (с помощью панели управления CloudConvert).

 53d6fe6b688c31c565907c81de625046  input.pdf
99d4c165f77af02015aa647770286cf9  input.png

Ресурсы

• API-документация
• Блог CloudConvert