README.md

Copicake PHP

🍰 Copicake, a data-driven image generating service to let you generate any social media material with just ONE CLICK.

• 🔗 Website: https://copicake.com/
• 📘 Official API Docs: https://docs.copicake.com/

Installations

composer require copicake

Usage

Initialization

use Copicake\Copicake;

$copicake = new Copicake("YOUR_API_KEY");

Image

Create an image

create(mixed $data)

try {
  $response = $copicake->image->create([
    'template_id' => 'jfwrFJdR3z1eF8BcEhSnAFyhxgOq',
    'changes' => [
      ['name' => 'text-9so09m', 'text' => 'hello world', 'fill' => '#ff0000'],
      ['name' => 'image-yeavh7', 'src' => 'https://your_website.com/test.png'],
    ],
    'options' => [
      'webhook_url' => 'https://your_website.com/webhook_url'
    ]
  ]);
}
catch(Exception $exception) {
  var_dump($exception);
}

Get an image

get(string $renderingId)

try {
  $response = $copicake->image->get('YOUR_RENDERING_ID');
}
catch(Exception $exception) {
  var_dump($exception);
}

Get an image (long polling)

getUntilFinished(string $renderingId)

Sometimes you may notice that your image is still under processing state, this is because the image is still being processed in the background by our servers.

In this way, we provide another handy method called getUntilFinished() to get the image until the image is ready.

Internally, this is just a wrapper of get() method with built-in retry mechanism. If after MAX_RETRY_TIMES and the image is still under processing state, we will throw an exception to let you know.

try {
  $response = $copicake->image->getUntilFinished('YOUR_RENDERING_ID');
}
catch(Exception $exception) {
  var_dump($exception);
}