Skip to content
Cynox IoT Documentation

Getting started

Basics

The public-facing API for the Cynox IoT Cloud uses the GraphQL query language.
There are libraries available for GraphQL in most programming languages. You can find an overview on the GraphQL website.

Where reasonable, the API follows best practices outlined by GraphQL, using Connections for pagination and Global Object Identification based on the Node interface.

The GraphQL API Endpoint is https://api.staging.iot.cynox.de/graphql/. At this URL you will also find a GraphiQL Browser-IDE for prototyping queries and mutations and exploring the schema.

You can also browse the schema documentation.

Authorization

Authorization to the GraphQL API is based on the OAuth 2.0 Standard.

There are two options for authentication: The Client Credentials grant or the Authorization Code with PKCE grant. They will be explained in the following sections.

Scopes

The following scopes can be requested when requesting an OAuth token:

  • profile:read, profile:write: read / write user information
  • campsites:read, campsites:write: read / write information about the user’s campsites
  • devices:read, devices:write: read / write information about the user’s devices
  • devices:control: Issue commands to the user’s devices

Depending on your application’s needs you may not be granted access to all scopes.

Token URI

The Token URI is https://api.staging.iot.cynox.de/o/token/. Use it to exchange the Authorization Code for an access and a refresh token or to obtain a new access token from a refresh token.