Sites

Export a Capacitor app project for a site

Builds a Capacitor project that opens the site at its connected domain or hypamoon.app address, with the icon and splash from the site, a proposed app id in reverse domain form, an offline screen and push registration through Hypamoon, plus a README for building in Android Studio and Xcode. Returns a signed download link to a zip, valid for 15 minutes; a new export replaces the previous one. The zip contains no keys, tokens or passwords. Building and submitting in the cloud will come in a later phase.

post/sites/{id}/app-export

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/sites/{id}/app-export
  • 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:write)

Path parameters

idstring uuid required

The id of the site.

Request body

app_idstring

Reverse domain form, like com.example.app. Leave it out for a proposal from the domain or the site's address. Cannot change after the first upload to a store.

app_namestring

The name under the icon. Leave it out to use the site's name.

icon_pathstring

Path of an image on the site to use as the icon, like /icon-1024.png (square PNG, 1024x1024). Leave it out to pick the best icon the site has.

background_colorstring

Background of the icon and splash screen as a hex color, like #ffffff. Leave it out to use the site's theme color.

Response

The project is ready to download.

download_urlstring required

A signed link to the zip, valid for 15 minutes. Give it to the user; never store it.

expires_atstring required
app_idstring required
app_id_reasonstring required
app_namestring required
app_urlstring required

The address the app opens: the connected domain, or the site's hypamoon.app address.

iconstring nullable required

Where the icon is in the zip, or null when the user must add one.

background_colorstring required
filesstring[] required
bytesinteger required
warningsstring[] required
testboolean required

Changes

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