Render product mockups with Laravel

Use this pre-built prompt to get an agent writing SudoMock HTTP calls correctly.

Prerequisites

Before you start, you’ll need:

A SudoMock API key
A PSD reachable over HTTPS

Guide

Set your API key

The Http client ships with the framework, so there is nothing to install. Put the key in the environment and read it through a config entry. The two UUIDs stay empty until the next step fills them.

SUDOMOCK_API_KEY=sm_your_api_key
SUDOMOCK_MOCKUP_UUID=
SUDOMOCK_SMART_OBJECT_UUID=

'sudomock' => [
    'key' => env('SUDOMOCK_API_KEY'),
    'mockup' => env('SUDOMOCK_MOCKUP_UUID'),
    'smart_object' => env('SUDOMOCK_SMART_OBJECT_UUID'),
],

One macro gives every call the same base URL, header and timeout.

app/Providers/AppServiceProvider.php

use Illuminate\Support\Facades\Http;

public function boot(): void
{
    Http::macro('sudomock', function () {
        return Http::baseUrl('https://api.sudomock.com')
            ->withHeaders([
                'x-api-key' => config('services.sudomock.key'),
            ])
            ->acceptJson()
            ->timeout(120);
    });
}

Read the key with config() rather than env(). Once the config is cached in production, env() answers null and every request comes back 401.

Upload the template once

The upload returns every layer you can address later, each with its own UUID. An Artisan command keeps that out of the request path.

app/Console/Commands/ImportMockup.php

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Http;

class ImportMockup extends Command
{
    protected $signature = 'sudomock:import {url} {name}';

    public function handle(): int
    {
        $response = Http::sudomock()
            ->post('/api/v1/psd/upload', [
                'psd_file_url' => $this->argument('url'),
                'psd_name' => $this->argument('name'),
            ])
            ->throw();

        $data = $response->json('data');

        $this->line('mockup: '.$data['uuid']);

        foreach ($data['smart_objects'] as $object) {
            $this->line($object['name'].': '.$object['uuid']);
        }

        return self::SUCCESS;
    }
}

php artisan sudomock:import \
  https://example.com/heavyweight-tee.psd "Heavyweight tee"

Copy the mockup UUID and the UUID of the smart object you want to fill into .env. A template is uploaded once and rendered as often as you like.

Render from a route

The route takes an artwork URL and answers with the finished image. On Laravel 11 and newer, php artisan install:api creates routes/api.php if the application does not have one yet.

routes/api.php

use App\Http\Controllers\RenderMockupController;

Route::post('/mockups', RenderMockupController::class);

app/Http/Controllers/RenderMockupController.php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Http;

class RenderMockupController extends Controller
{
    public function __invoke(Request $request): JsonResponse
    {
        $input = $request->validate([
            'artwork_url' => ['required', 'url'],
        ]);

        $mockup = config('services.sudomock.mockup');
        $layer = config('services.sudomock.smart_object');

        $response = Http::sudomock()
            ->post('/api/v1/renders', [
                'mockup_uuid' => $mockup,
                'smart_objects' => [[
                    'uuid' => $layer,
                    'asset' => ['url' => $input['artwork_url']],
                ]],
                'export_options' => [
                    'image_format' => 'webp',
                    'image_size' => 2048,
                ],
            ])
            ->throw();

        return response()->json([
            'image' => $response->json(
                'data.print_files.0.export_path'
            ),
        ]);
    }
}

Examples

Create a mockup from a PSD

Every field of the upload call

Render a PSD mockup

Every field of the render call

Retrieve a single job

Collect an async render

Create a webhook endpoint

Get called back instead of polling

Fit and blend modes

How artwork meets a print area

Errors

Every code, and which ones are worth retrying

Get started

Learn

Resources

Render product mockups with Laravel

Prerequisites

Guide

Examples

Create a mockup from a PSD

Render a PSD mockup

Retrieve a single job

Create a webhook endpoint

Fit and blend modes

Errors

​Prerequisites

​Guide

​Examples

Create a mockup from a PSD

Render a PSD mockup

Retrieve a single job

Create a webhook endpoint

Fit and blend modes

Errors

Prerequisites

Guide

Examples