Overview

---

Introduction

SweetConnect provides HTTP APIs for programmatic access to selected platform functionality. This documentation describes authentication, shared response structures, and the endpoints currently exposed by the documented services.

---

API Areas

The SweetConnect APIs cover several areas of the platform:

• Asset Management — Manage asset structures, assignments, lifecycle states, and related information.
• Documents and Media — Manage documents, pictures, and their relationships to assets and maintenances.
• Maintenance Management — Create and manage maintenances, their status, and their history.
• Users and Tenants — Manage users, identities, tenants, and organizational membership.
• Industrial Data and Metrics — Access data sources, machine states, logs, streams, and operational metrics.
• Sharing and Supporting Data — Manage document sharing, categories, languages, and related metadata.

---

API Fundamentals

The SweetConnect APIs follow a set of common conventions:

• API endpoints are versioned in their URL paths. The currently documented endpoints use /v1.
• Protected endpoints use bearer tokens for authentication.
• Access to individual operations depends on the user's roles and the relevant resource context.
• Structured request and response payloads generally use JSON. File-related endpoints may use or return other media types.
• Endpoint-specific parameters, request bodies, permissions, and responses are described in the API reference.

---