Sites

Get a drop link and the files the user uploaded

status is open (waiting for the user), done (the user pressed Done) or expired (after 24 hours). files lists what arrived (photos with variant 2048 or 640, width and height; private originals are not listed); deploy_files is the same list in the form POST /sites and PUT /sites/{id} take (path, sha256, bytes, no content). With site_id and status done, site_version is the new version of the site that already has these files: send only the HTML. You may give a file another path in the deploy; keep its sha256 and bytes.

get/sites/drops/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/sites/drops/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Path parameters

idstring uuid required

The id of the drop link.

Response

The drop link and its files.

idstring uuid required

The id of the drop link; pass it to get_drop (GET /sites/drops/{id}).

status'open' | 'done' | 'expired' required

open: waiting for the user. done: the user uploaded the files. expired: 24 hours passed; create a new one.

site_idstring uuid nullable required

The site the link is for, or null.

created_atstring required
expires_atstring required

When the link stops working (24 hours after it was made).

completed_atstring nullable required

When the user finished uploading, or null.

images_onlyboolean required

True when the link only takes images (an editor made it).

as_isboolean

True when files are kept exactly as they are (for moving a site): no web versions, same names, and paths that follow the user's folders exactly.

keep_zipboolean

True when a .zip stays one file (a download) instead of being unpacked.

strip'location' | 'all' | 'none' required

What the upload page removes from photos before upload: location (the default, only the GPS location), all (all metadata) or none. Web versions are re-encoded and carry no metadata at all.

folderstring nullable required

The folder under /media/ the files land in, or null for the user's own folder names.

max_filesinteger required

How many files the user can add with this link (a photo with its versions counts once).

originals_keptinteger required

How many originals were kept. They are private: never on a site, only downloadable in the portal.

urlstring

Only when the link is created: the page to give the user. It is not shown again.

user_messagestring

A sentence to give the user.

next_stepstring

What to do next.

Changes

No recorded changes to this operation across all 1 revision of this API.