API Foundations
What an application built on HiAPI needs before anything else runs: where the packages come from, what a program has to initialise, the geometry objects it passes around, and the two cross-cutting services — messages and XML serialization — that the rest of the API assumes are already there. A script that drives a running web service over HTTP starts from its own page here instead of from the packages.
Ordered the way a new application meets them: getting the packages, writing the first program — in process or over HTTP — then the pieces every later page takes for granted.
Starting an Application
- HiAPI Packages and Sample Code — The NuGet feed, the package dependency chain, why there is no UI package, and the two sample repositories
- Getting Started with HiAPI — Wiring the feed into a project, initialising and finalising the runtime, and the five steps every HiNC program follows
- Driving the Web Service over HTTP — The REST contract and the request bodies its framework document gets wrong, sign-in, the reply envelope, named file roots, the project lifecycle, key-based editing, and replaying a mission on a shared instance
- Step Color Trees over HTTP — Coloring a run's steps by condition from a script or an agent: the color tree routes, the shape of a tree, check and preview before an add, the answers, and the color index every connected user shares
What Every Page Assumes
- Geometry Objects — The STL-backed interface behind every geometry type, and the basic and management geometries built on it
- Message Management — Three independent message channels — diagnostic, UI notification, application log — and why they are never mixed
- About XML IO — The serialization pattern every persisted HiAPI type implements, and the registration that must happen before a project is loaded