GraphQL Playground

GraphQL is an open-source data query and manipulation language for APIs and a query runtime engine. GraphQL enables declarative data fetching where a client can specify exactly what data it needs from an API.

For general information about the GraphQL, see graphql.org

GraphQL is served via HTTP, which allows to send GraphQL queries via standard HTTP GET and POST requests. Details about the HTTP transport can be found here: https://graphql.org/learn/serving-over-http/

There is also a GraphQL Playground available, which provides a simple to use Web GUI to explore the GraphQL API and to try out GraphQL queries.

While GraphQL can be used directly, there is also a large amount of client libraries available which help with consuming GraphQL APIs: https://graphql.org/code/

GraphQL also supports subscriptions, which allow the API to push data to the client. The IOmeter API uses either the GraphQL over WebSocket Protocol or the GraphQL over Server-Sent Events Protocol to enable such subscriptions.

The API supports two authentication methods:

Basic Auth

Basic Auth uses a simple basic authentication header generated as follows:

"Basic " + base64("<partner_id>:<partner_secret>")

Example

• Partner ID: b1451a19-53c7-4e8a-87a0-7c45d3807e9d
• Partner Secret: JjNQKxIYugVSqCrxkbNfQ8Onpvd07K2G
• Header: Authorization: Basic YjE0NTFhMTktNTNjNy00ZThhLTg3YTAtN2M0NWQzODA3ZTlkOkpqTlFLeElZdWdWU3FDcnhrYk5mUThPbnB2ZDA3SzJH

WSSE

WSSE transmits a digest consisting of the secret, a nonce and a timestamp.

The nonce is a randomly generated value with 16 bytes, timestamp is a UTC timestamp in RFC3339 format, and the secret is the partner secret.

The header is generated as follows:

func GenerateWSSE(partnerID string, secret string) string {
               created := time.Now().UTC().Format(time.RFC3339)
            
               nonceBytes := make([]byte, 16)
               _, _ = rand.Read(nonceBytes)
               nonce := hex.EncodeToString(nonceBytes)
            
               text := nonce + created + secret
            
               digestHash := sha256.New()
               digestHash.Write([]byte(text))
               digestString := hex.EncodeToString(digestHash.Sum(nil))
            
               passwordDigest := base64.StdEncoding.EncodeToString([]byte(digestString))
            
               return fmt.Sprintf(
                  "UsernameToken Username=\"%s\", PasswordDigest=\"%s\", Nonce=\"%s\", Created=\"%s\"",
                  partnerID,
                  passwordDigest,
                  nonce,
                  created,
               )
            }
            

Example

• Partner ID: 0da56783-39b2-4b43-adaa-301d247fcd59
• Partner Secret: 1NNbSclq0ULA364TZBB4Hr0EYoRK
• Created: 2025-10-20T12:38:50Z
• Nonce: eb6c574e12fcfa4cd091a5b21ad0abdb
• Password Digest: NWNiYTMyNzNmZGQ2NWU2ODhjZjc1Mzg3MzliZGE4MTgyMjhjY2Q3NWU1NmYxMzEyM2NhMmI3MWI0ZmMwODY3MA==
• Header: Authorization: UsernameToken Username="0da56783-39b2-4b43-adaa-301d247fcd59", PasswordDigest="NWNiYTMyNzNmZGQ2NWU2ODhjZjc1Mzg3MzliZGE4MTgyMjhjY2Q3NWU1NmYxMzEyM2NhMmI3MWI0ZmMwODY3MA==", Nonce="eb6c574e12fcfa4cd091a5b21ad0abdb", Created="2025-10-20T12:38:50Z"

To start the account linking process, the Partner App needs to open the connection URL for the user.

The connection URL can be obtained from the connectUrl query:

query {
  connectUrl(
    redirectUrl: "https://example.com"
    state: "123456"
  )
}    

The URL will open the IOmeter App, where the user will be asked to confirm linking their account to the partner.

If the user accepts, the redirect URI is called with the following additional parameter:

• installation_id, which represents the unique account ID of the user

If account linking fails, the redirect URI is called with an error parameter instead which may have one of the following values:

• access_denied, if user declined linking their account
• unauthorized_client, if the the partner isn’t authorized to link their account
• server_error, if linking process failed for an unexpected reason

Once accounts are linked the Partner will have access to installation data using the Partner API.