Skillnader

Här visas skillnader mellan den valda versionen och den nuvarande versionen av sidan.

--- api:graphql [2023/04/28 11:32] – dokuadmin
+++ api:graphql [2023/05/10 09:18] (aktuell) – [GraphQL] dokuadmin
@@ Rad 1: / Rad 1: @@
 <markdown>
@@ Rad 13: / Rad 14: @@
 # Orbiqs GraphQL API
-Orbiqs GraphQL API nås på {Orbiqs URL}/graphql.
+Orbiqs GraphQL API nås på `{Orbiqs URL}/graphql`.
-## Autentisera
+## GraphQL
+Om GraphQL känns som ett nytt koncept, börja med läsa [GraphQL:s egna guide](https://graphql.org/learn/).
+## 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
 ```javascript
-body: "grant_type=client_credentials&client_id=example&client_secret=test&scope=iqalarm",
 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.
+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](https://graphql.org/learn/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](https://altairgraphql.dev/).
 </markdown>