Property Level

The property-level endpoint runs on the Simphony workstation, providing direct, low‑latency access to POS services on the venue network. It provides resilience during WAN or cloud outages (requests can continue locally), tighter performance for high‑throughput use cases like kiosks, and deterministic behavior aligned to the property’s live configuration. It requires local certificate management and network controls, per‑workstation endpoint availability, and operational discipline around patching and version alignment and monitoring. It’s ideal for on‑premises workflows that must keep serving during internet disruptions, while the cloud endpoint can still be used for enterprise governance and multi‑site coordination.

Considerations for Property-Level Deployments

Properties must meet the following location-specific API requirements:

  • On-premises implementation authentication:

    The property-level method uses TLS 1.2 with server‑side X.509 certificates for transport security (see the Oracle MICROS Simphony Configuration Guide). Application calls are authorized using short‑lived access tokens issued by Enterprise Back Office through the cloud STS. Refresh tokens are time‑bound in that each endpoint must reach the STS at least once around every 10 days to renew credentials. If an endpoint remains offline beyond this window, its refresh token expires and it cannot authenticate until it reconnects to the STS and completes a new sign‑in or registration. Ensure outbound HTTPS to the STS is allowed and schedule refresh well before expiry.

    When creating API accounts for STS Gen 2 in Enterprise Back Office API Account Management, set the Client Scope to Both or Local. This allows tokens acquired for that client to authorize access to the on-premises API.

  • TLS Certificate Requirement: HTTPS is required for property-level deployments. Ensure a valid root certificate authority-backed TLS certificate is on all workstations.
  • Default port and API path:
    • The default port for property-level deployments is 5443
    • API paths beyond the base URL mirror those of the cloud endpoints
  • The Notification API and Connection status are only available from enterprise-level deployments. These are not available for property-level deployments.
  • Moving API request and response handling from the enterprise level to the property level (typically hosted on workstation clients) could result in increased compute and resources required on those clients.

Additional considerations for property-level deployments:

  • Certificates and security: Someone with access to the Simphony workstation running the endpoint must provision and rotate local certs and enforce mutual TLS and least‑privilege scopes per device or app.
  • Performance: Typically lower latency and more consistent at peak; ideal for kiosks and other high‑throughput flows.
  • Resilience: Continues to operate during WAN and cloud outages; aligns to the property’s live configuration.
  • Deployment and operations: Per‑workstation availability; requires local network and firewall rules, patching, monitoring, and version alignment.
  • Scale: More setup overhead at multi‑site scale; consider automated provisioning, MDM, and cert lifecycle tooling.
  • Observability: With the local endpoint, there is less reportability, as the cloud-based dashboards that can be leveraged with the enterprise, cloud-based endpoints are not available.
  • Compliance: Ensure local devices and networks meet PCI and corporate standards.
  • The following services are not supported for property-level endpoints:
    • Organization service:
      • Get search for locations within an organization
      • Get search for revenue centers within a location
    • Configuration service:
      • Get the barcode collection
  • The following notifications are not supported for location-based endpoints:
    • Organizations Notification
    • Configuration Notification
    • Check Notification
    • Employees Notification
  • The Check Notification is supported for property-level integrations.

See Location-Based API Requirements for Simphony Transaction Services Gen 2 for more information.