Knackly API (v1)

Key Terms in the Knackly API

• Workspace - a given customer's site on Knackly.
• Catalog - a database / repository / table where a the customer's data is stored and related documents are generated. One workspace can contain any number of catalogs. A catalog is the boundary for data access permissions in Knackly: groups of users have rights to view/modify data, or see the documents produced from that data, based on whether they have access to the catalog or not. API keys are also granted access on a per-Catalog basis.
• Model - Knackly's term for a schema. Each catalog has (or is based on) a Model. Different catalogs may be based on different models, or multiple catalogs may be based on the same model. A model defines Variables, which in turn define the "shape" of an instance of that model. Models are object-based. Variables can be scalars or arrays; Knackly data types include "text", "number", "date", "true/false", and "object". (Object-type variables also define which Model the object data must adhere to.) There are also "selection" variables, where the answer acts as a foreign key (usually a text string) referring to some other object (which itself is stored in either a Table, an external Query, or elsewhere within the user data Record).
• Record - a single item in a Catalog -- a data object that adheres (more or less) to the Model of the catalog in which it is stored. In other words, a data Record (in a catalog) is an instance of the catalog's data Model.
• Template - Knackly generates documents based on Templates. A template is created and maintained by an Admin user in Knackly. One Record (or other object), combined with one Template, will generate one document.
• App - a process within Knackly, defined by an Admin user, that interactively gathers data from an end-user, stores it in a Record (in a Catalog), and generates some number of documents from that data. There is no limit to how many documents (based on templates) that a given app can produce; it can be dynamic based on the data provided. Multiple Apps can also be run against the same Record at different times.