Simplicate koppelen | Helpcentrum

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 Simplicate-omgeving waarin je een API-key en API-secret kunt aanmaken (Instellingen > API).
De naam van je omgeving: het deel vóór .simplicate.nl in je adresbalk, bijvoorbeeld jouwbedrijf.

Verbinden

Ga in APIboard naar Koppelen > Koppelingen.
Zoek Simplicate 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 Simplicate-omgeving in een ander tabblad en ga naar Instellingen en open API.
Maak een nieuwe API-sleutel aan voor een gebruiker die alle modules mag zien die je in APIboard wilt hebben.
Kopieer de API-key en het API-secret en plak ze in de velden API-key en API-secret in APIboard.
Vul bij Simplicate-omgeving het deel vóór .simplicate.nl in. Vul eventueel een naam voor de koppeling in.
Klik op Koppelen.
APIboard haalt direct de eerste gegevens op (Data wordt opgehaald…). Daarna zie je Verbonden met Simplicate, 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.

Wat de sleutel ziet

Een Simplicate-sleutel ziet precies wat de gebruiker ziet bij wie hij hoort. Heeft die gebruiker geen rechten op een module, of heeft je Simplicate-licentie die module niet, dan zijn de bijbehorende tabellen in APIboard leeg of niet beschikbaar. Dat is geen fout van de koppeling. Wil je meer gegevens zien, maak dan een sleutel aan voor een gebruiker met meer rechten en gebruik Opnieuw verbinden.

APIboard leest alleen. Er wordt nooit iets in je Simplicate-omgeving gewijzigd.

Account of administratie kiezen

Er is geen keuzescherm: één API-key hoort bij één Simplicate-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. Heeft je omgeving meerdere eigen organisatieprofielen, dan komen die samen in dezelfde tabellen, met een kolom die het profiel aanduidt.

Welke gegevens je krijgt

Onderwerp	Tabellen
Relaties	Organisatieprofielen, Organisaties, Personen, Contactpersonen
Verkoop	Verkoopkansen, Offertes, Offerteregels
Projecten	Projecten, Projectdiensten, Projectmedewerkers, Urensoorten per dienst, Inkoop
Uren en kosten	Uren, Urensoorten, Urengoedkeuringen, Onkosten, Kilometers
Facturen	Facturen, Factuurregels, Betalingen
Personeel	Medewerkers, Teams, Roosters, Contracten, Verlof, Verlofsaldi, Verzuim
Eigen velden	Definities van je eigen velden

Statussen en soorten komen ook als leesbare tekst mee (de kolommen met _label). Je eigen velden bij organisaties, personen, projecten, verkoopkansen en medewerkers staan in één kolom Eigen velden, met waarde en label per veld. Je vraagt de gegevens op via de API en ziet ze in de Datawerkbank. Alle tabellen en velden staan in de API-documentatie van Simplicate.

Hoe vaak vernieuwd

Stamgegevens (zoals organisaties, personen, projecten en medewerkers) worden elke ronde bijgewerkt op basis van wat er gewijzigd is. Uren, facturen, betalingen, onkosten, kilometers, verlof en verzuim worden ook incrementeel opgehaald. Eén keer per ronde telt APIboard per periode na of het aantal rijen nog overeenkomt met Simplicate, en vult het aan als dat niet zo is. Een correctie op een oud uur of een oude factuur komt zo ook binnen.

De eerste vulling van gegevens met een datum (zoals uren en facturen) 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. Open verkoopkansen en contracten 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?.

Wat we niet ophalen

Documenten en bijlagen, de tijdlijn met berichten, workflows en timers.
Planning (toewijzingen aan projecten), omdat die een aparte Simplicate-licentie vraagt.
Conceptfacturen als voorstel, herinneringen en de losse urenverantwoording per periode (de goedkeuring van uren komt wel mee).
Wijzigingen terugschrijven: APIboard leest alleen.

Goed om te weten

Verwijderde rijen. Simplicate geeft geen signaal als iets is verwijderd. APIboard herkent dat door per ronde de lijst met id’s te vergelijken met wat er bij de bron staat, en markeert zulke rijen als verwijderd bij de bron. Dat gebeurt binnen de periode die bij je pakket hoort; een oudere verwijdering zie je niet.
Goedkeuring van uren. De goedkeuringsstatus is er alleen als je in Simplicate met een supervisor-review werkt. Zonder die review blijft de tabel Urengoedkeuringen leeg en is de status in dashboards niet beschikbaar.
Eigen velden. Welke velden er zijn, haalt APIboard uit je omgeving. Een nieuw eigen veld verschijnt na de eerstvolgende ronde.
APIboard laat tijd tussen de aanroepen en verdeelt een grote eerste vulling over meerdere runs. Bij een limiet van Simplicate wacht APIboard een paar minuten.
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. Gebruik een sleutel van dezelfde Simplicate-omgeving. Je vindt Opnieuw verbinden (pijlicoon) in het zijpaneel dat opent als je op de kaart van de koppeling klikt.
Een koppeling verwijderen (Koppeling verwijderen) wist ook alle opgehaalde gegevens. Dat kan niet ongedaan worden gemaakt.

Problemen oplossen

De API-key of het secret klopt niet. Controleer of je beide helemaal hebt gekopieerd, zonder spaties, en of de sleutel in Simplicate nog actief is. Maak zo nodig een nieuwe aan onder Instellingen > API.
Deze Simplicate-omgeving bestaat niet. Controleer het subdomein. Vul alleen het deel vóór .simplicate.nl in, zonder https:// en zonder paden.
Deze API-sleutel heeft geen toegang tot Simplicate. De gebruiker bij de sleutel mag de API niet gebruiken of heeft te weinig rechten. Pas dat aan in Simplicate of maak een sleutel voor een andere gebruiker.
Simplicate is tijdelijk niet bereikbaar. Probeer het later opnieuw.
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. Kies Bekijk abonnementen om te upgraden, of koop een extra koppeling.
De pil Fout bij de koppeling. Een synchronisatie is mislukt of de sleutel is ingetrokken. APIboard probeert het bij een tijdelijke fout later zelf opnieuw; bij een ingetrokken sleutel gebruik je Opnieuw verbinden.
Een tabel is leeg. Controleer of de module in je Simplicate-licentie zit en of de gebruiker bij de sleutel die module mag zien.