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 TimeChimp-account waarin je een API-sleutel kunt genereren (Instellingen > API V2).
Verbinden
- Ga in APIboard naar Koppelen > Koppelingen.
- Zoek TimeChimp 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.
- Log in op je TimeChimp-account in een ander tabblad.
- Ga naar Instellingen > API V2.
- Genereer een nieuwe API-sleutel.
- Kopieer de sleutel en plak hem in het veld API-sleutel in APIboard. 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 TimeChimp, 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.
Account of administratie kiezen
Er is geen keuzescherm: één API-sleutel hoort bij één TimeChimp-omgeving. Heb je meer omgevingen, koppel ze dan elk met een eigen sleutel (binnen de koppelingenlimiet van je pakket). Dezelfde omgeving kun je niet twee keer koppelen.
Welke gegevens je krijgt
| Onderwerp | Tabellen |
|---|---|
| Tijd en kosten | Uren, Tags op uren, Ritten, Uitgaven, Planningen |
| Facturen | Facturen, Uren op facturen, Ritten op facturen, Uitgaven op facturen, Projecten op facturen, Kortingen op facturen, Toeslagen op facturen |
| Klanten en projecten | Klanten, Contacten, Klanten van contacten, Projecten, Taken |
| Organisatie | Gebruikers, Teams, Rollen, Tags, Contracttypen, Voertuigen, Bedrijfsschema |
| Prijzen | Producten, Btw-tarieven |
Je vraagt de gegevens op via de API en ziet ze in de Datawerkbank. Alle tabellen en velden staan in de API-documentatie van TimeChimp.
Hoe vaak vernieuwd
Teams, rollen, tags, btw-tarieven, voertuigen en contracttypen worden elke ronde volledig opnieuw geladen. Gebruikers, klanten, contacten, projecten, taken en producten worden incrementeel opgehaald op basis van het wijzigingsmoment. Uren, ritten, uitgaven, facturen en planningen worden ook incrementeel opgehaald, en daarnaast terugwerkend aangevuld tot de grens van je pakket. Een correctie op een oud uur of een oude factuur komt via het wijzigingsmoment ook buiten die grens binnen. Eén keer per ronde vergelijkt APIboard de id-lijst met TimeChimp om bij de bron verwijderde rijen te herkennen.
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
- APIboard laat tijd tussen de aanroepen en verdeelt een grote eerste vulling over meerdere runs. Bij een limiet van TimeChimp wacht APIboard een paar minuten.
- Facturen zonder datum (concepten) worden meegenomen.
- Upgrade je je pakket, dan vult APIboard de oudere jaren later aan.
- 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 plakt een nieuwe sleutel. APIboard herkent bij deze koppeling niet of een sleutel bij een ander account hoort, dus gebruik een sleutel van hetzelfde account.
- 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 of je de hele sleutel hebt gekopieerd en of hij in TimeChimp nog actief is. Genereer zo nodig een nieuwe sleutel onder Instellingen > API V2.
- 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?