cloudconvert php

cloudconvert-php.ini

นี่คือ 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 หรือ PSR-7 StreamInterface เป็นพารามิเตอร์ตัวที่สอง

คุณยังสามารถอนุญาตให้ไคลเอ็นต์อัปโหลดไฟล์ไปยัง 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() ส่งคืน PSR-7 StreamInterface ซึ่งสามารถใช้เป็นทรัพยากร PHP โดยใช้ detach()

เว็บฮุค

คุณสามารถสร้าง Webhooks ได้บน CloudConvert Dashboard และคุณยังสามารถค้นหาความลับในการลงนามที่จำเป็นได้จากที่นั่น

 $ 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 โดยใช้ PSR-7 RequestInterface :

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

URL ที่ลงนาม

URL ที่ลงชื่ออนุญาตให้แปลงไฟล์ตามความต้องการโดยใช้พารามิเตอร์การค้นหา URL เท่านั้น PHP SDK อนุญาตให้สร้าง URL ดังกล่าว ดังนั้น คุณจึงต้องได้รับฐาน URL ที่ลงนามและข้อมูลลับในการลงนามบน CloudConvert Dashboard

 $ 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

ตามค่าเริ่มต้น การดำเนินการนี้จะรันการทดสอบการรวมกับ Sandbox API ด้วยบัญชี CloudConvert อย่างเป็นทางการ หากคุณต้องการใช้บัญชีของคุณเอง คุณสามารถตั้งค่าคีย์ API ของคุณได้โดยใช้ตัวแปรสภาพแวดล้อม CLOUDCONVERT_API_KEY ในกรณีนี้ คุณต้องไวท์ลิสต์แฮช MD5 ต่อไปนี้สำหรับ Sandbox API (โดยใช้แดชบอร์ด CloudConvert)

 53d6fe6b688c31c565907c81de625046  input.pdf
99d4c165f77af02015aa647770286cf9  input.png

ทรัพยากร

• เอกสาร API
• บล็อก CloudConvert