Orbiqs GraphQL API

Orbiqs GraphQL API nås på {Orbiqs URL}/graphql.

GraphQL

Om GraphQL känns som ett nytt koncept, börja med läsa GraphQL:s egna guide.

Autentisering

För att autentisera sig mot API:et krävs en giltig oauth2 token, som kan efterfrågas från {Orbiq URL}/oauth2/token. T.ex. med client_credentials

headers: {
    'Content-Type': 'application/x-www-form-urlencoded'
},
body: "grant_type=client_credentials&client_id=example&client_secret=test&scope=iqalarm";
 
// res => { "token": "abcd", "expiry": 3600 }

där client_id och client_secret är inlogg för en användare i Orbiq.

För requests till GraphQL API:et specificeras sedan autentiseringen i en header som Authorization: Bearer {token}, där {token} är ett giltigt token från Orbiq.

Utforska API:et

API:et är självbeskrivande där tillgängliga frågor kan fås genom Introspection. Förslagsvis är det bästa sättet att lära sig Orbiqs GraphQL API att utforska det med valfri GraphQL klient. Till exempel med Altair.