cloudconvert php

cloudconvert-php

Este es el SDK de PHP oficial para CloudConvert API v2 .

Instalar

Para instalar el SDK de PHP, deberá utilizar Composer en su proyecto.

Instale el SDK junto con Guzzle:

composer require cloudconvert/cloudconvert-php guzzlehttp/guzzle

Este paquete no está vinculado a ningún cliente HTTP específico mediante PSR-7, PSR-17, PSR-18 y HTTPlug. Por lo tanto, también necesitarás instalar paquetes que proporcionen psr/http-client-implementation y psr/http-factory-implementation (por ejemplo, Guzzle).

Creando empleos

 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 )

Puede utilizar CloudConvert Job Builder para ver las opciones disponibles para los distintos tipos de tareas.

Subiendo archivos

Las cargas a CloudConvert se realizan mediante tareas import/upload (consulte los documentos). Este SDK ofrece un método de carga 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 ' );

El método upload() acepta una cadena, un recurso PHP o PSR-7 StreamInterface como segundo parámetro.

También puede permitir directamente a los clientes cargar archivos en 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 > 

Descarga de archivos

CloudConvert puede generar URL públicas para utilizar tareas de export/url . Puede utilizar el SDK de PHP para descargar los archivos de salida cuando finalice el trabajo.

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

}

El método download() devuelve un StreamInterface PSR-7, que puede usarse como recurso PHP usando detach() .

Ganchos web

Los webhooks se pueden crear en el panel de CloudConvert y también puede encontrar allí el secreto de firma requerido.

 $ 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, puede construir un WebhookEvent usando una RequestInterface PSR-7:

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

URL firmadas

Las URL firmadas permiten convertir archivos a pedido únicamente utilizando parámetros de consulta de URL. El SDK de PHP permite generar dichas URL. Por lo tanto, debe obtener una base de URL firmada y un secreto de firma en el Panel de 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 ' );

Establecer una región

De forma predeterminada, se utiliza la región en la configuración de su cuenta. Alternativamente, puede configurar una región fija:

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

Pruebas unitarias

 vendor/bin/phpunit --testsuite unit

Pruebas de integración

 vendor/bin/phpunit --testsuite integration

De forma predeterminada, esto ejecuta las pruebas de integración en la API Sandbox con una cuenta oficial de CloudConvert. Si desea utilizar su propia cuenta, puede configurar su clave API utilizando la variable de entorno CLOUDCONVERT_API_KEY . En este caso, debe incluir en la lista blanca los siguientes hashes MD5 para la API Sandbox (usando el panel de CloudConvert).

 53d6fe6b688c31c565907c81de625046  input.pdf
99d4c165f77af02015aa647770286cf9  input.png

Recursos

• Documentación API
• Blog de CloudConvert