Render a view of a blank with its prints

GET

/v1/blanks/{id}/views/{viewId}/mockup.png

curl --request GET \
  --url https://api.pixonaut.app/v1/blanks/example/views/example/mockup.png \
  --header 'Authorization: Bearer <token>'

Operation ID: blanks.views.mockup.get

The view’s photo with a published template drawn in each of its regions, as a PNG a storefront shows: a sweater’s front and both sleeves on one photo, a roll’s window of its print. A region with no template shows its placement’s fill colour, or the photo alone. An unknown blank, view or template, and a photo that is gone, are 404.

Authorizations

• publishableKey
• secretKey

Parameters

Path Parameters

id

required

The blank.

string

>= 1 characters <= 64 characters

The blank.

viewId

required

One of the blank’s views.

string

>= 1 characters <= 64 characters

One of the blank’s views.

Query Parameters

variant

A variant ref of the blank: the view’s photo of it, each region’s print at its size.

string

>= 1 characters <= 64 characters

A variant ref of the blank: the view’s photo of it, each region’s print at its size.

prints

What each region shows: placementId:templateId@version pairs, comma-separated, each a published template. A region left out shows its placement’s fill colour, or the photo alone.

string

<= 1024 characters

What each region shows: placementId:templateId@version pairs, comma-separated, each a published template. A region left out shows its placement’s fill colour, or the photo alone.

size

The long edge in pixels, clamped to the sizes the api renders.

string

The long edge in pixels, clamped to the sizes the api renders.

Responses

200

The view with its prints

Media typeimage/png

string

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

304

The caller’s copy, named by its ETag, is current

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

401

Refused: unauthorized

Media typeapplication/json

object

error

required

string

Examples

Exampleunauthorized

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

403

Refused: origin_forbidden, feature_disabled

Media typeapplication/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

404

No blank, view, photo or published template answers to these ids

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

422

Refused: mockup_rect_unusable, mockup_rect_outside_photo, mockup_placed_box_empty, photo_decode_failed, mockup_mesh_unusable, mockup_cut_unusable, mockup_mask_decode_failed, mockup_uv_decode_failed, mockup_uv_pass_mismatch, unknown_variant, variant_retired, variant_has_no_photo, prints_invalid, mockup_mask_unreadable, mockup_uv_unreadable, invalid_query

Media typeapplication/json

object

error

required

string

reason

Always sent with unknown_variant, variant_retired, variant_has_no_photo, prints_invalid.

string

ref

Always sent with unknown_variant.

string

variant

With variant_retired: The retired variant’s ref. With variant_has_no_photo: The variant’s ref. Always sent with variant_retired, variant_has_no_photo.

string

view

The view’s label. Always sent with variant_has_no_photo.

string

viewId

Always sent with variant_has_no_photo.

string

Examples

invalid_query

{
  "error": "invalid_query"
}

mockup_cut_unusable

{
  "error": "mockup_cut_unusable"
}

mockup_mask_decode_failed

{
  "error": "mockup_mask_decode_failed"
}

mockup_mask_unreadable

{
  "error": "mockup_mask_unreadable"
}

mockup_mesh_unusable

{
  "error": "mockup_mesh_unusable"
}

mockup_placed_box_empty

{
  "error": "mockup_placed_box_empty"
}

mockup_rect_outside_photo

{
  "error": "mockup_rect_outside_photo"
}

mockup_rect_unusable

{
  "error": "mockup_rect_unusable"
}

mockup_uv_decode_failed

{
  "error": "mockup_uv_decode_failed"
}

mockup_uv_pass_mismatch

{
  "error": "mockup_uv_pass_mismatch"
}

mockup_uv_unreadable

{
  "error": "mockup_uv_unreadable"
}

photo_decode_failed

{
  "error": "photo_decode_failed"
}

prints_invalid

{
  "error": "prints_invalid",
  "reason": "string"
}

unknown_variant

{
  "error": "unknown_variant",
  "reason": "string",
  "ref": "string"
}

variant_has_no_photo

{
  "error": "variant_has_no_photo",
  "reason": "string",
  "variant": "string",
  "view": "string",
  "viewId": "string"
}

variant_retired

{
  "error": "variant_retired",
  "reason": "string",
  "variant": "string"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

429

Refused: rate_limited

Media typeapplication/json

object

error

required

string

Examples

Examplerate_limited

rate_limited

{
  "error": "rate_limited"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

500

Refused: artwork_decode_failed, encode_failed, downscale_size_overflow, input_too_large, mockup_warp_unreadable, mockup_mesh_unreadable, mockup_cut_unreadable, mockup_uv_view_missing, composite_failed, template_defaults_invalid, db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

artwork_decode_failed

{
  "error": "artwork_decode_failed"
}

composite_failed

{
  "error": "composite_failed"
}

db_error

{
  "error": "db_error"
}

downscale_size_overflow

{
  "error": "downscale_size_overflow"
}

encode_failed

{
  "error": "encode_failed"
}

input_too_large

{
  "error": "input_too_large"
}

mockup_cut_unreadable

{
  "error": "mockup_cut_unreadable"
}

mockup_mesh_unreadable

{
  "error": "mockup_mesh_unreadable"
}

mockup_uv_view_missing

{
  "error": "mockup_uv_view_missing"
}

mockup_warp_unreadable

{
  "error": "mockup_warp_unreadable"
}

template_defaults_invalid

{
  "error": "template_defaults_invalid"
}

string

Allowed value: Internal Server Error

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

503

Refused: print_box_unavailable, asset_store_unavailable, assets_unavailable

Media typeapplication/json

object

error

required

string

Examples

asset_store_unavailable

{
  "error": "asset_store_unavailable"
}

assets_unavailable

{
  "error": "assets_unavailable"
}

print_box_unavailable

{
  "error": "print_box_unavailable"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.