Project

Get the blueprint for a kind of application

Advice for building a webshop, appointments and bookings, a restaurant site, or a course or membership: the questions that matter (each with why and a default when the user does not know; only the ones marked blocking stop a working result), the build plan with the Hypamoon tools in order, the go-live checklist for the country (EU in detail, UK and US basics, a general fallback), the common mistakes, and a structured-data (JSON-LD) snippet for search engines. Advice only: nothing here is required of the user. The checklist is guidance, not legal or tax advice.

get/advice

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/advice
  • 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: project:read)

Query parameters

type'webshop' | 'bookings' | 'restaurant' | 'course_membership' | 'wordpress_portal' | 'app'

The kind of application. Required, unless you ask for a topic. app: a build plan for an app with accounts, data per user and uploads, from description.

descriptionstring

Only with type app: what the app should do, in the user's words (one or two sentences).

topic'sandbox_blocks_upload' | 'image_too_large' | 'version_conflict' | 'phone_verification_required' | 'site_not_visible' | 'is_hypamoon_down'

Instead of type: one known problem (an upload blocked by a sandbox, an image too large, version_conflict, phone verification, a site nobody else can see, is Hypamoon down) with what to do and what to tell the user. Every blueprint also lists them in known_problems.

countrystring

Where the business is: an ISO country code like NL, or a name. Leave it out for the Netherlands.

audience'consumers' | 'businesses' | 'both'

Who the user sells to; consumers (the default) adds the consumer rules.

Response

The blueprint, with a short markdown summary. With topic: that one known problem (id, symptom, what_to_do, tell_user, other_topics).

type'webshop' | 'bookings' | 'restaurant' | 'course_membership' | 'wordpress_portal' required
titlestring required
summarystring required
countrystring nullable required
region'eu' | 'uk' | 'us' | 'other' required

eu (detailed), uk and us (basics), other (a general fallback).

audience'consumers' | 'businesses' | 'both' required
how_to_usestring required

For the agent: inform yourself, ask only the blocking questions, use the defaults for the rest, and offer the checklist; never a questionnaire or a gate.

notestring required

Guidance, not legal or tax advice.

summary_markdownstring required

Changes

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