Brugerimport fra API
Formål
Du kan via denne vejledning se, hvordan du kan bruge API'et til XFlow til import af brugere fra et eksternt system.
Sidst redigeret: 06/03-2025
Opret API brugerimport
Du opretter selve brugerimporten inde i XFlow i administrationsdelen ved at klikke på menupunktet "Import” i venstre side og herefter “API Brugerimport" i doprdown-menuen.
Her skal der trykkes på "Opret ny" i højre hjørne:
2. Vejledning
Når du opretter brugerimporten vil adressen til API'et automatisk blive vist i brugergrænsefladen, og du vil få et token, som din brugerimport skal bruge til at logge på API'et med. Det er derfor vigtigt, at du gemmer det token, som der også står i oprettelsesbilledet. Man bliver først mødt af denne boks:
Når der trykkes på "API", vil informationerne for opsætningen fremgå:
Du kan naturligvis altid hente et nyt token via brugergrænsefladen i XFlow ved at vælge "Opsætning" på din brugerimport og herefter klikke på "Generer token", som vist nedenstående.
Det er dog meget vigtigt, at der ikke vilkårligt trækkes en ny token, da den allerede kan være i brug og således kan ødelægge en eksisterende opsætning.
3. Forbind brugerkilde med API
Nu skal du have forbundet din brugerkilde med API'et, og det gør du ved at sende oplysninger til API'et.
Når du udformer din request, så skal det gøres på nedenstående form:
"users": [
{ "firstName": "string",
"lastName": "string",
"email": "string",
"cpr": "string",
"customData1": "string",
"customData2": "string",
"customData3": "string",
"groupImportReferences": [
"string"
],
"roles": [
"string"
],
"nearestManagerEmail": "string",
"nearestManagerCpr": "string",
"importNearestManager": true,
"importRoles": true
}
]
Du får her en kort beskrivelse af informationerne:
FirstName: Fornavn
LastName: Efternavn
Email: E-mailadresse
Cpr: CPR-nummer
CustomData1:
CustomData2:
CustomData3:
CustomData4:
GroupImportReferences: Navn på reference til rettighedsgruppe(r)
Roles: Rolleangivelse(r)
NearestManagerEmail: E-mailadresse på nærmeste leder
NearestManagerCpr: CPR-nummer på nærmeste leder
ImportNearestManager: Skal nærmeste leder sættes på brugeren: true/false
ImportRoles: Skal roller sættes på brugeren: true/false
Du skal som minimum oplyse fornavn, efternavn og e-mailadresse på brugeren. E-mailadressen er brugerens nøgle, hvilket betyder, at brugere opdateres i stedet for at blive oprettet, såfremt brugeren findes i forvejen i XFlow med den samme email. Dette gælder dog kun for brugere, der er oprettet igennem API'et.
Dokumentationen for det API, der hører til den pågældende XFlow-installation, kan findes ved at åbne "https://api.DIN_XFLOW_URL" i en browser.
Hvis du gerne vil se et eksempel på dokumentationen til den seneste version af API'et, kan du se på vores test-API.
Nedenstående viser et simpelt eksempel ved brug af PowerShell, hvor man importerer en bruger ved navn "John Doe" ind igennem API'et.
Invoke-RestMethod -Method 'Post' -Headers @{'Content-Type'='application/json';'publicApiToken'='InsertXFlowHere'} -Body '{"users": [{"firstName":"John", "lastName":"Doe","email":"bob@test.com"}]}' -Uri 'https://api.InsertXFlowUrlHere/UserImport/ImportUsers'
Man vil kunne finde personen inde i administrationen under “Alle brugere”, hvor oprindelseskolonnen viser, at personen kommer fra en API:
