Skip to content

What is available today

The SplashMe Open API is being opened in stages. This page is the current state of each part; the changelog records when a stage opens.

Area Status Notes
Authentication: OAuth2 authorization code flow, PKCE, refresh tokens, user info, client signature Available Client credentials are issued on request. The main use today is third-party verification: letting a user sign in with their SplashMe account so your software knows who they are and which controllers they own.
Users & sites: profile, role, sites, controllers and their online status Available Included with every client.
Device API v1: cloud reads and writes through the controller’s shadow On request Not enabled for third-party clients by default. The endpoints are documented so you can plan an integration; contact support if yours needs them.
Device API v2: cloud state document, queries, actions, events and envelope key Internal Used by the SplashMe development team only while it is being proven in production. It is not offered to third-party clients and may change without notice.
Command Protocol v2 on the LAN: mDNS discovery and signed frames over HTTP Open for testing Any controller on firmware 2.5.46 or later. Discover it and fetch its signed state frame today; the wire specification and the controller’s key are provided by support. Behaviour may still change.
  • Build sign-in now. The OAuth2 flow, tokens and the user and site endpoints are stable and supported. A “Sign in with SplashMe” button that verifies the user and lists their controllers is the integration to ship today.
  • Plan device control against v1. When cloud control opens for your client it will be Device API v1 first. Write your integration against the v1 pages and ask support to enable it.
  • Experiment with the controller on your own network. LAN access needs no cloud permission. Use it to learn the protocol, test against real hardware and prototype a LAN-first integration.
  • Do not build on cloud v2 yet. The v2 cloud pages describe what the development team uses internally. They are published so that the LAN frames and the protocol are fully explained, not as a surface you can call.

Email support@splashmepool.com.au with the name of your integration, the SplashMe account it belongs to and which of the areas above you need. Device API v1 is enabled per client; the wire specification and controller keys for LAN work are provided under agreement.