SignageWallDevelopers

Core concepts

Versioning and compatibility

The version in the URL identifies an independently maintained public contract.

Versioned base path

The production API base is https://api.signagewall.com/api/partner/v1. All public resources are under the versioned path /api/partner/v1. A future breaking contract would use a different major version rather than silently changing v1.

Compatibility promise

Partner API v1 is independently versioned from the CMS API, player API, database schemas, Mongoose models, and internal application DTOs. Internal changes do not automatically enter Partner responses.

Compatible changes can include new endpoints, new optional fields, and new enum members where documented as extensible.

Safe client behavior

  • Ignore response members your client does not understand.
  • Do not parse opaque URLs or depend on their host.
  • Handle unknown application slugs through the generic rendering metadata.
  • Use IDs as opaque strings.