Skip to content

Developer Documentation

Hyvä POS is in closed beta

Hyvä POS is currently in a closed beta (pilot phase) with a small group of merchants. It is not yet generally available: the App Store release follows the pilot, and features and configuration may still change - possibly in backwards-incompatible ways - before the general release. Want to take part? Sign up at hyva.io/pos.

The PRO module adds a pos/ REST API on top of standard Magento, and an extension system built around provider bridges. This section is for developers integrating with or extending Hyvä POS.

The Shape of the Integration

  • The app is not extensible. It is a native iOS application with a fixed, tested surface.
  • The Magento side is, the way Magento always is: everything the POS does server-side (orders, customers, receipts) is ordinary Magento data you can observe and extend with ordinary Magento development.
  • Bridges are the structured extension point: provider contracts for store credit, gift cards, reward points, RMA, shipping labels, credit limits, customer validation and customer pricing. Implement the contract, register your provider, and the POS drives your module. Start at building bridges.
  • Payment-terminal integrations are the exception: they live inside the native app and are built by Hyvä in partnership with the payment provider. There is no server-side bridge for terminals.

The API

All pos/ endpoints are standard Magento web API routes: they authenticate with the same three methods as the app (integration token, OAuth 1.0a, admin token), are authorised through Magento ACL resources, and speak JSON. See the API reference.