GraphQL Playground

Admin Backend

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 the GraphQL over WebSocket Protocol to enable such subscriptions. The protocol is supported by most client libraries.

API Authentication uses API Keys, consisting of a token and a secret. API Keys can be created within the Admin Backend.

To authenticate with the API, one needs to send a basic access authentication header on every request, using the token as the username and the secret as the password.

Example:

• Token: zFfsKV98XcsMNtgj71jmx41oamNFKx9K
• Secret: JjNQKxIYugVSqCrxkbNfQ8Onpvd07K2G
• Header: Authorization: Basic ekZmc0tWOThYY3NNTnRnajcxam14NDFvYW1ORkt4OUs6SmpOUUt4SVl1Z1ZTcUNyeGtiTmZROE9ucHZkMDdLMkc=

To open the IOmeter app via a deep link:

• Integrate the Provider API and get a RegistrationToken object.
• Obtain the deep link URL from the deeplink field in RegistrationToken and open it within your app

For Flutter:

final uri = Uri.tryParse(deeplink);
if (uri != null) {
    launchUrl(uri);
} else {
    //TODO: bad value, check your API response
}

For iOS (Swift):

if let url = URL(string: deeplink) {
    if UIApplication.shared.canOpenURL(url) {
        UIApplication.shared.open(url, options: [:], completionHandler: { (success) in
            if success {
                print("Deep link opened successfully")
            } else {
                print("Failed to open deep link")
            }
        })
    } else {
        print("Cannot open URL: \(deeplink)")
    }
} else {
    print("Invalid URL string")
}

For Android (Kotlin):

val intent = Intent(Intent.ACTION_VIEW, Uri.parse(deeplink))
// Check if there's an app that can handle the deep link
if (intent.resolveActivity(context.packageManager) != null) {
    context.startActivity(intent)
    println("Deep link opened successfully")
} else {
    println("No app found to handle the deep link")
}