2.7 Validation and First Run

Once your manifest is ready:

  1. Host the manifest on an HTTPS-accessible URL (e.g., https://myapp.example.com/manifest.xml).

  2. Implement the mandatory endpoints in your app (ping, enroll, remove, section, response, alert). Initially, each can return simple 200 OK responses. Over time, you will align them to the official Retailys interface specs.

  3. Register the app by calling:

    POST https://core.retailys.com/apps/register?url=manifestUrl
    Content-Type: application/json
  4. Check the response to see if the core successfully registered your app. If validation succeeds, your app is marked “active”.

At this point, your app is integrated into the Retailys ecosystem:

  • If you specified <gateway>, your public endpoints are published at https://api.retailys.com/... (with any required authentication).

  • Datanest sets up new tables/fields from your entity definitions.

  • The Dashboard adds menu entries and pages (canvases) for your app if you defined <dashboard:section>.

Last updated