Använd vårt Experimentella API

Vyer använder ett GraphQL-API som är designat för att användas av Vyerappen men på begäran kan API:et göras tillgängligt även för externa användare. API:et är strukturerad att användas tillsammans med Relay men alla GraphQL-klienter är också kompatibla. Nedan följer en guide som hjälper dig att komma igång med API-användandet som utvecklare!

NOTERA: Eftersom API:et är framtaget för användning av Vyerappen så versionshanteras den inte och ändringar kan ske ofta utan att det informeras ut till externa användare. Förlita er därav INTE på API:et i någon form av produktionsmiljö.

Servicekonton

Vyer ger tillgång till API:et genom så kallade servicekonton. Servicekonton fungerar till stor del likadant som vanliga användarkonton på plattformen, de har till exempel namn som syns i appen. Servicekonton är däremot ämnade att användas av utvecklare samt i tekniska områden som integrationer.

För att få ett servicekonto kontaktar du oss på [email protected] så hjälper vi dig att skapa en long-lived bearer token (nyckel) som används för autentisering. Samma gäller om du behöver skapa en ytterligare nyckel eller vill ta bort en som inte längre används eller behövs.

Servicekonton ges automatiskt Redigerare-behörighet på plattformen med access till alla fastigheter i organisationen. Detta möjliggör servicekontot att utföra admin-uppgifter som till exempel att skapa nya fastigheter. Ska servicekontot ha en begränsad behörighet går det alltid att ändra den i efterhand från din organisations användartavla på Vyer.

Läs mer om behörigheter här.

Göra förfrågningar till API:et

När du har en long-lived bearer token (nyckel), som är kopplat till ett service konto, kan du börja göra förfrågningar till API:et. Autentisering hanteras genom nyckeln.

Även om det är möjligt att använda vilken API-klient som helst rekommenderar vi Insomnia eftersom det stödjer introspection queries och har en användbar utforskare för API schemat.

För att börja göra förfrågningar med Insomnia behöver du genomföra följande steg:

Skapa en ny GraphQL förfrågning till https://app.vyer.com/graphql
Sätta bearer token för förfrågningen till den nyckel som är kopplat till ditt service konto.

När stegen ovan är utförda kan du skicka följande förfrågan (innehållet kan behöva uppdateras om API:et ändrats sedan detta skrevs):

query getViewer {
  viewer {
    id
    firstName
    lastName
    orgMemberships {
      edges {
        node {
          org {
            id
            name
          }
        }
      }
    }
  }
}

Svaret borde ge dig information om din användare, med andra ord servicekontot. Bland annat användar-ID:t samt organisations-ID:t som kontot är kopplat till. Organisations-ID:t kan vara användbart även för andra förfrågningar.

API-Schema

GrapqhQL-schemat innehåller information om datatyper och beskrivningar om olika förfrågningar, uppdateringar och så vidare. Schemat kan kommas åt genom användning av så kallade GraphQL introspection queries vilket är ett automatiskt sätt för GraphQL-klienter att hämta schemat. Insomnia klienten hämtar detta automatiskt vilket ger tillgång till automatiska kompletteringar av förfrågningar samt en enkel utforskare av schemat.