Cloud API

The Cloud API deployment model offers a managed, internet-accessible API endpoint hosted by Oracle and dedicated to your Simphony enterprise. Customers and partners connect through a single, centrally governed interface—with separate test and production environments—using standard authentication and role-based access. This approach streamlines connectivity by eliminating venue-specific firewall configurations, accelerates partner onboarding, and ensures consistent versioning, scalability, and operational safeguards like monitoring, rate limiting, and centralized credential management. Additionally, it enables cloud-based control of menus, pricing, and configurations across multiple sites, supporting faster rollouts and reducing total cost of ownership.

Compared to on-premises Location API deployments, the Cloud API endpoint offers a richer integration surface, advanced enterprise information, and enhanced notifications—including support for Organizations, Configuration, Check, and Employees notifications (on-premises supports Check notifications only). It also provides organization and revenue center search and barcode collection APIs, which are unavailable in on-premises Location API deployments.

Cloud access depends on WAN availability, which may impact use cases that require continued operation during internet disruptions or demand low latency (such as kiosks). For greater resilience, you can pair the cloud endpoint with a local workstation endpoint.

Considerations for Cloud API Deployments

  • Connectivity: Single, managed, internet‑accessible endpoint; simpler partner onboarding and no venue‑by‑venue firewall work.
  • Governance: Centralized auth, credentials, roles/scopes; easier enterprise control of menus, pricing, and access.
  • Scale and consistency: Consistent versioning, rate limits, monitoring, and capacity managed by Oracle.
  • Dependency: Requires WAN availability; plan for graceful degradation when the internet or cloud path is down.
  • Observability: Central logs, metrics, and throttling; easier multi‑site reporting and support.
  • Rollout speed: Faster to enable across estates; lower total operational overhead.
  • The following calls are only available with the cloud-based endpoint:
    • 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 supported for cloud deployments:
    • Organizations Notification
    • Configuration Notification
    • Check Notification
    • Employees Notification