API Calls Flow

Here you can find a typical flow of API operations for a deployment process.

  1. Request the deployment structure (/structure).
    • The JSON object returned by the endpoint represents the structure of a Deployment in Heretto. Use this object to build Navigation Trees, or breadcrumbs.
    • Each node in the structure will have an href field. To get the content for a page, pass this href into the content endpoint.
  2. From a node in the structure, request page content (/content)?for-path={an href from the structure endpoint}. This returns the HTML content and metadata for a page.
  3. Search: enables searching in all pages in the structure.