Page tree
Skip to end of metadata
Go to start of metadata

Beskrivning funktion

Denna exportmall gör det möjligt för LifeVision att hämta ut persondata från systemet genom att kalla på en export via APIv3. Se bilagan "LifeVision standard integration" nedan för mer detaljer om exakt vilken data som hämtas.
Exportmallen ska finnas i systemet för alla kunder som har version 2019.2603 eller högre. Den är som standard inaktiverad och kan endast aktiveras av BRP anställda.

Obs. det finns en annan exportmall som LifeVision använder sig av som är till för att hämta ut information om träningspass. Den är alltså separat och inte standardiserad, med andra ord behöver den exportmallen läggas in manuellt efter överenskommelse.

Förutsättningar

  • Exportmallen är aktiverad av BRP och BRP har förmedlat exportmallens ID samt API URL till LifeVision
  • Det finns en integratör roll som är korrekt konfigurerad
  • Det finns en användare/person med rollen integratör uppsatt åt LifeVision.

Hur man skapar en användare med rollen integratör:

Steg 1. Öppna menyn Kontaktregister -> Inställningar -> Roller.
Steg 2. Skapa en ny roll och döp den exempelvis "Integratör med api-export", bocka i rutan "Är API-integratör" och klicka sedan på "Exportmallar via API" i listan så att den raden blir markerad. Klicka sedan på spara och ok.
Steg 3. Öppna menyn Kontaktregister -> Personer och klicka sedan på ny. 
Steg 4. Fyll i alla nödvändiga uppgifter på personen. Under fliken "Personal" kan du välja vilken roll personen ska ha, välj den roll som nyss skapades (i detta exempel "Exportmallar via API"). Det är viktigt att både lösenord och e-post sätts på denna användare. Spara slutligen personen.
Steg 5. Förmedla användarens e-post och lösenord till LifeVision.


Detta behöver göras av LifeVision för att hämta ut data:

Detta är en kort sammanfattning av  punkt 3.1 och 4.5 i APIv3 dokumentationen.

Först måste de autentisera sig genom att skicka en POST mot URL/api/ver3/auth/login med deras användares e-post/lösenord. Uppgifterna skickas i förfrågans body-sektion:
{
"username": "integrator@emailaddress.com",
"password": "someSecurePassword"
}
I responsen får de en access token som de skickar med i alla följande anrop.

För att trigga exporten behöver de sedan skicka en GET mot URL/api/ver3/services/exporttemplate/id där id byts ut mot den aktuella exportmallens id. De kan även skicka med någon av de valfria parametrarna count, date, includeAnonymized, offset, showTotal i förfrågans body-sektion likt följande:
{
"count": 500,
"offset": 0
}