Wat je nodig hebt
- De rol Admin of Member in je organisatie. Viewers hebben geen toegang tot Koppelen. Zie Wie mag koppelen?.
- Tweestapsverificatie (2FA) op je APIboard-account.
- Een vrije plek in je pakket: Proefperiode en Basis 3 koppelingen, Team 7, Pro 10 (plus eventueel een gekochte extra koppeling).
- Een API-token van Dyflexis. Dat maak je niet zelf aan: Dyflexis geeft het uit na een aanvraag (zie de stappen).
- De systeemnaam van je Dyflexis-omgeving.
Verbinden
- Ga in APIboard naar Koppelen > Koppelingen.
- Zoek Dyflexis bij Beschikbare koppelingen (of typ de naam in het zoekveld) en klik op de kaart. Er opent een venster dat je stap voor stap begeleidt.
- Vraag een API-token aan: mail sales@dyflexis.com met als onderwerp “API token request” en vraag een API-token aan voor de APIboard-koppeling, met de rechten business (verplicht), absence (verzuim) en payroll (contracturen). Klokrechten (clock) zijn niet nodig.
- Heb je de token al? Een beheerder met systeembeheerrechten vindt hem in Dyflexis via het tandwiel rechtsboven, menu Koppelingen.
- Kijk in de adresbalk als je in Dyflexis bent ingelogd: na app.dyflexis.com/ staat je systeemnaam, bijvoorbeeld app.dyflexis.com/jouwbedrijf/… Kopieer alleen dat deel. Het hele adres plakken mag ook.
- Vul in APIboard de Systeemnaam en het API-token in. Vul eventueel een Naam voor deze koppeling (optioneel) in.
- Klik op Koppelen.
- APIboard haalt direct de eerste gegevens op (Data wordt opgehaald…). Daarna zie je Verbonden met Dyflexis, met de dashboards die klaarstaan. Op Koppelen > Koppelingen staat de pil Bezig met ophalen… tot de eerste volledige ronde klaar is; daarna staat er Actief.
De eerste keer haalt APIboard de organisatiestructuur, medewerkers, roosters, uren en verzuim op over de hele historie van je pakket. Dat kan bij een grote organisatie even duren en gebeurt op de achtergrond.
Account of administratie kiezen
Er is geen keuzescherm: één token hoort bij één Dyflexis-systeem. De koppeling krijgt je eigen naam; heb je die niet ingevuld, dan de naam van je kantoor als er precies één vestiging is, anders de systeemnaam.
Welke gegevens je krijgt
| Onderwerp | Tabellen |
|---|---|
| Uren en rooster | Geregistreerde uren, Roosterdiensten |
| Verzuim | Verzuim, Verzuimdagen |
| Medewerkers | Medewerkers, Contracten, Medewerkers per eenheid |
| Organisatie | Vestigingen en afdelingen |
Je vraagt de gegevens op via de API en ziet ze in de Datawerkbank. Alle tabellen en velden staan in de API-documentatie van Dyflexis.
Hoe vaak vernieuwd
Vestigingen en afdelingen, medewerkers en contractgegevens worden elke ronde volledig opgehaald. Uren, verzuim en roosters haalt APIboard de eerste keer over de hele historie van je pakket op (het rooster ook 90 dagen vooruit). Daarna kijkt APIboard alleen nog naar het wijzigvenster: uren en verzuim van de laatste twee kalendermaanden, en het rooster vanaf een maand terug tot 90 dagen vooruit.
De eerste vulling van gegevens met een datum (zoals facturen, uren of mutaties) begint op 1 januari van het jaar dat bij je pakket hoort: Proefperiode en Basis dit kalenderjaar, Team ook vorig jaar, Pro ook twee jaar terug. Stamgegevens (zoals relaties of rekeningen) worden altijd volledig opgehaald. Wat al is opgehaald, verwijdert APIboard niet als je pakket kleiner wordt.
Hoe vaak dat gebeurt, hangt af van je pakket (Proefperiode, Basis, Team of Pro): zie Hoe vaak worden gegevens vernieuwd?.
Goed om te weten
- Wat ouder is dan het wijzigvenster, wordt na de eerste vulling niet meer gelezen. Correcties daarin komen dus niet meer binnen en worden ook niet als verwijderd gemarkeerd.
- Een verwijderde dienst of urenregel verdwijnt pas na twee gemiste rondes.
- De rechten payroll en absence zijn optioneel. Zonder payroll blijven Contracten en Medewerkers per eenheid leeg, zonder absence blijven Verzuim en Verzuimdagen leeg. Er komt geen foutmelding; APIboard probeert het na 24 uur opnieuw.
- Loonkosten, opmerkingen, proeftijd en onkosten haalt APIboard niet op. Klokgegevens ook niet.
- Upgrade je je pakket, dan volgt opnieuw een volledige vulling.
- Opnieuw verbinden vervangt alleen je inloggegevens. De koppeling, alle opgehaalde gegevens en de syncstand blijven staan, de status gaat terug naar Actief en de volgende synchronisatie haalt alleen wijzigingen op. Het verbindscherm opent direct, zonder bevestigingsvraag. Je vult systeemnaam en token opnieuw in. Log je in met een ander account, dan weigert APIboard dat met de melding “Dit is een ander account dan de koppeling die je opnieuw verbindt. Log in met hetzelfde account.” Dan is het een nieuwe koppeling.
- Je vindt Opnieuw verbinden (pijlicoon) in het zijpaneel dat opent als je op de kaart van de koppeling klikt.
- Een koppeling of account verwijderen (Koppeling verwijderen of het verwijderpictogram bij een account) wist ook alle opgehaalde gegevens. Dat kan niet ongedaan worden gemaakt.
Problemen oplossen
- Koppelen mislukt. Controleer je gegevens en probeer het opnieuw. Dit is de standaardmelding. Controleer: de systeemnaam (alleen het deel na app.dyflexis.com/), of het token compleet is en zonder spaties, of het token nog actief is en of het het recht business heeft. Heeft het token dat recht niet, vraag Dyflexis dan om een nieuw token.
- Viewers kunnen geen koppelingen beheren. Je hebt de rol Viewer. Vraag een Admin van je organisatie om je de rol Member te geven, of om de koppeling te maken.
- Dit account is al gekoppeld. Wat je probeert te koppelen, staat al in je organisatie. Zoek het op onder Koppelen > Koppelingen.
- Je hebt je koppelingen-limiet bereikt voor je pakket. (of Je hebt je accounts-limiet bereikt voor je pakket.) Kies Bekijk abonnementen om te upgraden, of koop een extra koppeling of extra account.
- De pil Fout bij de koppeling. Een synchronisatie is mislukt of de toegang is verlopen of ingetrokken. APIboard probeert het bij een tijdelijke fout later zelf opnieuw; bij een verlopen toegang gebruik je Opnieuw verbinden.
Was dit artikel behulpzaam?