Browse the help center

Read the candidate images out of a brand pack

Answers the images in what you send — a ZIP of files, a single image, or a link to a brand page, whose drawn images, declared icons, preview images, CSS backgrounds, linked image files and inline data-URI images are all candidates.

Reference
POST https://YOUR-NETWORK-DOMAIN/rest-api/white-label/brand-images.do

Answers the images in what you send — a ZIP of files, a single image, or a link to a brand page, whose drawn images, declared icons, preview images, CSS backgrounds, linked image files and inline data-URI images are all candidates. Each answer carries the file's own name, what it turned out to be, where it was found and its bytes base64-encoded. Nothing is stored and no slot is decided here: the console measures each candidate and proposes a slot for it, and every accepted file goes through the white-label image upload, which applies its own rules. Send exactly one of file or url. Requires the WHITE_LABEL admin permission.

Query Params

url string

A public http(s) link to the brand's page, or to one image or ZIP

https://www.example.com/brand

Body

A multipart form: file (file).

Responses

200

{images: [{name, contentType, origin, bytes}], total, more, source: {kind, origin}}

400

Field errors under 'errors': none or both of file and url; the source empty, larger than the limit, of a kind that cannot be read, a PDF (its images cannot be extracted here), not downloadable, or holding no images at all

401

Authentication error

403

Insufficient permissions, naming the missing one

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.