The SME Connect documentation is divided into two main sections:
-
SME Connect Basics: This section describes a broader overview of SME Connect
application with illustrative examples of important user processes such as logging into SME Connect or joining a room.
-
API Services: This section provides links to each API service
and important packages for development. There are eight main services that make up SME Connect to handle the application's different
functionalities such as creating WebRTC connections, registering users, and authenticating tokens.
API Services
This section provides detailed reference documentation for the APIs used in SME Connect. For an introduction to SME Connect and its main processes,
please visit the SME Connect Basics section.
The APIs can be divided into three main subsections:
- Authentication and Authorization Services
-
Authn: Authenticates a JSON web token (JWT) from multiple sources
and authorizes a user to log into other SME Connect services
-
Client Auth: Authenticates the Tools Gateway & CAC login method
-
OAuth: Performs 3rd-party authentication validation
-
Email Manager*: Creates and validates OTPs for email logins
- User and Room Services
-
Presence: Managers user, room, and tool data
-
Signal: Handles WebRTC Connections
-
Asset Manager: Manages assets including PDFs, images, and CAD files
-
Email Manager*: Pre-approves and invites users to rooms
- Debugging Services
-
Graylog: Logs data and processes for debugging
* Note: The Email Manager is in both the “Authentication and Authorization Services” and “User and Room Services” because its endpoints handle both functionalities.