Shace
Shace Partner API

Uploads

Server

Listings reference images by URL, and there are two kinds of URL you can send in images.

Your own URLs. If your system already serves the photos, send those URLs directly on the listing. Shace downloads each image once, converts it to webp, resizes it to at most 2048 px, gives it a blur placeholder and hosts the copy itself; the listing never links to your server. The URL is remembered per organization, so pushing the same URL again is a no-op with no download, and a photo shared by several units (a building exterior) is fetched once. To replace a photo, send a new URL: Shace does not re-check a URL it has already fetched. URLs must be https on the default port, on a public hostname, without credentials and at most 2048 bytes; each file at most 15 MB in JPEG, PNG, WebP or HEIC, judged by its content (HEIC at most 50 megapixels). Shace follows up to 3 redirects and gives each image 20 seconds in all (looking up the host, redirects and download). A push gets 75 seconds for its image URLs, including time spent waiting behind other pushes; images not fetched by then fail as unavailable. Anything else, including a file that is not an image, a GIF or SVG, or a host name that does not resolve, is a 400 with the failing index under issues. A host that does not answer, times out, rate-limits or answers a server error is a 503 IMAGE_HOST_UNAVAILABLE, also with the failing index, and safe to retry: images that did get through are kept, so the retry only fetches the rest. A push with both kinds of failure is a 400 listing every failing index, since retrying it cannot succeed until the body is fixed. The same URL may not appear twice in images. A listing that mixes the two kinds of URL is fine.

Uploads. For photos that live behind a login, or in a system with no public URLs, send the files to POST /uploads/images and reference the returned URLs. Store them next to the unit in your system; later pushes send the same URLs and the listing comes back unchanged. Upload again only when a photo actually changed. Shace checks that each upload URL points into your organization's folder but does not fetch it, so a URL for an upload that no longer exists is accepted and shows as a broken image.

Deletion. An upload or a fetched copy that a push stops using is kept for about 15 minutes, then deleted once no listing in your organization references it. Within those minutes it can be sent again, on the same listing or another one, so a photo or floor plan that moves between units (unit A drops it and unit B gains it) survives if both pushes land within the window. After that, an upload URL shows as a broken image and one of your own URLs is fetched again. Dropping one of your URLs and adding it back within the window reuses the old copy, so to replace a photo, give it a new URL.

Order matters. images is the display order in Shace and the first image is the cover. Reordering the array counts as a change and re-indexes the listing.

Floor plans are optional, uploaded through POST /uploads/floor-plan and do not count towards the three-image minimum. Blur placeholders from the upload response are optional to pass along on the listing; leave them out if your system has nowhere to keep them. They are only read for upload URLs: images fetched from your URLs get theirs generated, and a blurPlaceholders entry for one of your own URLs is ignored.


Upload images

POST
https://api-sandbox.shace.se/partner/v1
/uploads/images
Bearer

Multipart form with one or more files fields. Each image is converted to webp, resized to at most 2048 px and given a blur placeholder, exactly like uploads from the app. Reference the returned URLs from images on a listing. At most 8 files per request, each at most 15 MB. JPEG, PNG, WebP and HEIC (at most 50 megapixels) are supported, judged by the file's content; any other format (GIF, SVG, AVIF) or a file that cannot be decoded is rejected with 400 BAD_REQUEST, and so is a file over 15 MB. A request body over 121 MB is refused with 413 before any file is read.

Upload images › Request Body

files
​string[] · minItems: 1 · maxItems: 8 · required

One multipart field per image, all named files. Order is preserved in the response. At most 15 MB each.

Upload images › Responses

OK

urls
​string[] · required

Public URLs, in upload order. Use these in images.

​object · required

Tiny base64 webp per URL. Pass along as blurPlaceholders on the listing if you want instant previews in the app; optional.


Upload a floor plan

POST
https://api-sandbox.shace.se/partner/v1
/uploads/floor-plan
Bearer

Multipart form with exactly one file field: PNG, JPEG, WebP or PDF, at most 15 MB. Reference the returned URL from floorPlanUrl on a listing. The format is read from the file's content, and the stored file's type follows it. Images may be at most 100 megapixels, or 32 megapixels for an interlaced PNG or progressive JPEG. A file in any other format, an image that does not decode (a corrupt or cut-off file) or is over those sizes, one whose content does not match the type or name it was sent with, a second file field or a file over 15 MB is a 400 BAD_REQUEST. A request body over 31 MB is refused with 413 before the file is read.

Upload a floor plan › Request Body

file
​string · binary · required

PNG, JPEG, WebP or PDF, at most 15 MB.

Upload a floor plan › Responses

OK

url
​string · uri · required

Public URL. Use it as floorPlanUrl.