API Concepts
This page will introduce you to the concepts that drive the design and intent of the Viare API's.
API Suite
The Viare API Suite is categorized into three primary groups:
Integration APIs
These are intended for high-volume usage for integrating, for example: Product information, Store Availability, Sales & Order import/export.
These are predominantly exposed via SOAP interfaces, which enables straightforward integration configuration & object mapping in most common integration frameworks and services.
Management APIs
These are HTTP & REST API's used by the Viare Management Console.
They are available for direct access, opening up a wealth of automation, integration options, as well as the ability to compose and integrate core functionality natively from within other apps and services.
Consumer-oriented APIs
These are HTTP & REST API's, designed to be used directly by customer-facing applications, including browser-based & native apps, or composed and consumed via API gateways or front-end frameworks such as Vercel.
They are optimized for scale and performance, featuring extremely fast response times, smart caching, and sensible object models.
Versioning
Viare provides version-less API endpoints, which always point at the most recently released versions.
From time to time, pinned versions are made available via versioned URL routes. These are provided in advance of breaking changes - allowing consumers of these APIs to manage compatibility concerns whilst always being able to target the latest version.
Updated 4 months ago