1.3 Terminology

  • Retailys / Retailys Ecosystem / Retailys Information System: A complete software solution made up of a core (Core) plus a set of applications and microservices.

  • Retailys Platform: Made up of the Retailys Cloud (PaaS) and Retailys Framework (the core’s services, documentation, tools, etc.).

  • Author: A tenant (i.e., a customer account) that develops and maintains applications.

  • Core - Apps + API gateway: A special program that provides basic services to all applications (registration, validation, API Gateway, etc.).

  • Core Version, Version Compatibility: Each major core version sets the standard that applications must adhere to. An application built for core version 3.x should work with all 3.x releases; no guarantee exists for 2.x or 4.x.

  • Manifest: An XML file in which an application describes its own meta-information (description, author, version, interface endpoints) and optional sections for configuring other applications (e.g., <datanest:section>, <dashboard:section>) which it uses.

  • Application Interface: A private (non-public) API through which the core communicates with each application. Any application must implement ping, enroll, remove, section, alert, and response API endpoints.

  • Public API (API Gateway): The gateway component exposes a unified public API at https://api.retailys.com. If an application wishes to publish certain endpoints, it does so via the manifest’s <gateway> element; the gateway then proxies incoming calls to the application’s private response endpoint.

Last updated