iVendNextDevelopers Request a sandbox

1. Welcome — one path for everyone who builds for iVendNext

This guide shows how to build a customer's own behaviour on iVendNext without changing iVendNext itself. It is for anyone who builds for an iVendNext customer: an outside partner, a customer's own IT team, and our own Custom Development team, which uses this same guide.

When to use this guide

Before you quote a customer. Place every need on the ladder (chapter 3) first: most needs are configuration or an outside app, and a few need an extension point we are still building (chapter 9). The worked examples by customer size are in chapter 15, and the full list of what is possible is in chapter 16.

What you can build

A customer's own behaviour, without changing iVendNext itself:

Your work keeps working when we upgrade iVendNext, because it uses only published doors. We upgrade every customer together, so a change that reaches inside our code breaks on the next release. That is why the doors exist.

The path, in nine steps

  1. Register as a builder.
  2. Get a sandbox site. We host one for you, with demo stores, tills and users, an admin login and API keys. Nothing to install (chapter 2).
  3. Learn the ladder: the six ways in, in order, and what is never allowed (chapter 3).
  4. Blueprint the project. For each need, write down its rung on the ladder. Add a scale profile (stores × tills × products × sales a day) and a map of the systems it connects.
  5. Build with the recipes and samples, and run the checks locally (chapter 14).
  6. Submit your work (not covered by the kit yet: chapter 17).
  7. We install it on the customer's site.
  8. Before every upgrade, the customer's own gate runs against the new release (chapter 14).
  9. Tell us what is missing: an extension point, a recipe, a sample, a defect (chapter 17).

The path is the same for a three-store shop and for a fifty-store chain. A large project's blueprint adds a scale proof, a release gate in the customer's own CI and, where an extension point is missing, joint work with us on that extension point. The project's needs decide that, not its size.

What is refused, and why

You never put your own server code inside a customer's iVendNext site, and you never change money, overrides or our code (the full list is in chapter 3). Your logic runs on your own server, or as data we install (a manifest, a sandboxed function). That keeps every customer on the same product and every upgrade safe.

When your service is down, and when the till is offline

Design for both from the first day:

Checking your work

Every chapter ends with the tests for its door, in its Technical notes. The checks you can run yourself are in chapter 14 (the manifest checker, the money kit, the customer's release gate); what we run at intake is not covered by the kit yet (chapter 17).

Read next: 2. Getting started · 3. The ladder and the four rules.

This page in the kit