cloudconvert php

cloudconvert-php

Este é o PHP SDK oficial para a API CloudConvert v2 .

Instalar

Para instalar o PHP SDK você precisará usar o Composer em seu projeto.

Instale o SDK junto com o Guzzle:

composer require cloudconvert/cloudconvert-php guzzlehttp/guzzle

Este pacote não está vinculado a nenhum cliente HTTP específico usando PSR-7, PSR-17, PSR-18 e HTTPlug. Portanto, você também precisará instalar pacotes que forneçam psr/http-client-implementation e psr/http-factory-implementation (por exemplo, Guzzle).

Criando Empregos

 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 )

Você pode usar o CloudConvert Job Builder para ver as opções disponíveis para os vários tipos de tarefas.

Fazendo upload de arquivos

Os uploads para o CloudConvert são feitos por meio de tarefas import/upload (consulte a documentação). Este SDK oferece um método de upload conveniente:

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

O método upload() aceita uma string, recurso PHP ou PSR-7 StreamInterface como segundo parâmetro.

Você também pode permitir que os clientes façam upload de arquivos diretamente para o 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 > 

Baixando arquivos

CloudConvert pode gerar URLs públicos para usar tarefas de export/url . Você pode usar o PHP SDK para baixar os arquivos de saída quando o trabalho for concluído.

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

}

O método download() retorna um StreamInterface PSR-7 , que pode ser usado como um recurso PHP usando detach() .

Webhooks

Webhooks podem ser criados no painel CloudConvert e você também pode encontrar o segredo de assinatura necessário lá.

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

Alternativamente, você pode construir um WebhookEvent usando um PSR-7 RequestInterface :

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

URLs assinados

URLs assinados permitem a conversão de arquivos sob demanda apenas usando parâmetros de consulta de URL. O PHP SDK permite gerar tais URLs. Portanto, você precisa obter uma base de URL assinada e um segredo de assinatura no painel 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 ' );

Definir uma região

Por padrão, a região nas configurações da sua conta é usada. Alternativamente, você pode definir uma região fixa:

 // Pass the region to the constructor
$ cloudconvert = new CloudConvert ([
    ' api_key ' => ' API_KEY ' ,
    ' sandbox ' => false ,
    ' region '  => ' us-east '
]);

Testes unitários

 vendor/bin/phpunit --testsuite unit

Testes de Integração

 vendor/bin/phpunit --testsuite integration

Por padrão, isso executa os testes de integração na API Sandbox com uma conta oficial do CloudConvert. Se desejar usar sua própria conta, você pode definir sua chave de API usando a variável de ambiente CLOUDCONVERT_API_KEY . Nesse caso, você precisa colocar na lista de permissões os seguintes hashes MD5 para API Sandbox (usando o painel CloudConvert).

 53d6fe6b688c31c565907c81de625046  input.pdf
99d4c165f77af02015aa647770286cf9  input.png

Recursos

• Documentação da API
• Blog CloudConvert