SyncApp Settings API — Why and How
Why This Matters
The Settings API is the central configuration store for every SyncApp — it holds PMS credentials, source IDs, and any integration-specific values. Understanding how it integrates into both the creation flow and the ongoing sync flow is essential.
What You'll Learn
- What SyncApp Settings API does: stores key-value configuration per location/source for use during SyncApp creation and data sync
- How Settings API integrates into the SyncApp creation flow (post-credential-creation)
- How Settings API integrates into the ongoing data sync flow (SyncApp reads settings at startup and runtime)
- How Settings API connects with other services in the SyncApp ecosystem
- The distinction between SyncApp credentials (in sync-app-authentication) and PMS settings (in Settings API)
Watch Video
Lesson Summary
The SyncApp Settings API is the configuration store that holds PMS-specific credentials and settings for each location and source. During SyncApp creation, sync-app-support writes the PMS credentials (e.g., office ID, client ID) to Settings API after the data source is created. When the SyncApp starts, it reads its settings from this API to know how to connect to the PMS. Settings API integrates with sync-app-authentication, sync-app-support, and the SyncApp runtime, making it a central hub in the SyncApp ecosystem.