Yuki API koppeling

Gewijzigd op Tue, 12 Dec 2023 om 08:57 AM

Wat is een API?

Een application programming interface (API) is verzameling programmeeropdrachten (vaak ook als interfaces aangeduid) die de functies van een programma aanroepen. Het is een methode die het mogelijk maakt om twee programma's met elkaar te laten communiceren.

Deze API maakt het dus mogelijk om applicaties/diensten van externe partijen informatie met Yuki uit te laten wisselen op de domeinen waarin je toegangsrechten hebt.

AANDACHT!

Voor jouw veiligheid heeft Yuki haar SOAP-webservices beveiliging verbeterd.

Onze koppelingen zullen dan enkel verbindingen met beveiliging TLS 1.2 en hoger accepteren. Dit levert voor de meeste koppeling implementaties (dit is voor applicaties die verbonden zijn met Yuki om data te versturen of op te halen) geen problemen op.

Heb je toch vragen neem dan even contact op met je software partner of het Support Team van Yuki.

Hoe leg ik een API koppeling?

De eerste stap is om te controleren of er al een koppeling bestaat met het software pakket waarmee je Yuki wilt koppelen. Alle koppelingen kun je hier terugvinden: Integraties. Hier vind je informatie over de specifieke koppeling.

Staat het software pakket waarmee je wilt koppelen er nog niet tussen? Dan raden we aan om bij het andere software pakket te vragen of zij een koppeling met Yuki willen opzetten. Yuki heeft een volledig open API omgeving, waardoor andere software heel makkelijk met Yuki kan koppelen.

Als het software pakket waarmee je wilt koppelen al een koppeling heeft, dan moeten een aantal instellingen vastgelegd worden in dat software pakket of bij de derde partij die de koppeling voorziet.

Om externe software toegang te geven tot informatie die in Yuki staat moet je een webservice API-sleutel en Administratie-ID (laten) genereren in Yuki waarmee die software ook zonder inloggen toegang heeft tot een Yuki domein.

Deze webservice API-sleutel kan worden gebruikt om een webservice toegang te verlenen op portaal-, domein-, of administratieniveau.

De (toegangs)rechten tot webservices in een domein of administratie zijn leidend en 'overrulen' dus de (toegangs)rechten tot webservices zoals deze zijn ingesteld op portaalniveau.

Voor een uitgebreide beschrijving van webservice toegang op portaalniveau zie artikel Webservices in portaal instellen.

Voor een uitgebreide beschrijving van webservice toegang op domein- of administratieniveau zie artikel Webservices in domein en/of administratie instellen.

LET OP!

Om gebruik te kunnen maken van de Purchase webservice moet per e-mail een formeel verzoek worden verstuurd naar support@yuki.nl

Vervolgens zal je van Yuki per e-mail een Client-ID/Secret ontvangen. Deze heb je naast de API-sleutel nodig voor de authenticatie om zodoende toegang te verkrijgen tot de Purchase webservice.

Wat kan ik met de Yuki API koppeling?

Financiële monitor widgets

Financiële monitor grafieken op je intranet webpagina's plaatsen

Webservices

Financiële rapportages ophalen zoals de openstaande posten en het huidige saldibalans
Aanmaken van memoriaalboekingen
Opvragen informatie over grootboekrekeningen en transacties
Aanmaken van verkoopfacturen
Ophalen en aanleveren van documenten
Zoeken in het archief
Ophalen van contactgegevens
Bijwerken of aanmaken van contactgegevens
Importeren van kastransacties
Aanmaken actieve en proefdomeinen
Ophalen en aanmaken gebruikers in domein
Controleren en/of bijwerken van specifieke backoffice rollen van portaalgebruikers in domein
Projecten (dossiers) aanmaken en bestaande projecten (dossiers) aanpassen
Controleren openstaande vragen voor backoffice in administratie
Ophalen van backoffice workflow in administratie.
Ophalen van statussen van ingediende btw-aangiften in Yuki (vanuit AdminPulse)
Aanmaken van inkoopfacturen.

Bij onrechtmatig gebruik van onze webservices kunnen wij de toegang tot onze API blokkeren.

In een domein met het prijsmodel bundle pricing moet de accountant in het portaal bij de gegevens (instellingen) van het domein klikken op de knop 'Beheer accountant features' en vervolgens het feature Yuki Webservice of Yuki Webservice Uitgebreid activeren.

In een domein zonder prijsmodel bundle pricing moet de accountant de Yuki Webservice of Yuki Webservice Uitgebreid via de Yuki Store in het domein activeren.

Financiële monitor widgets

De financiële monitor biedt diverse grafieken aan ten aanzien van de financiële gegevens in Yuki. Yuki stelt deze grafieken beschikbaar als widgets zodat deze bijvoorbeeld op een eigen intranet getoond kunnen worden.

Voor een uitgebreide beschrijving van de financiële monitor widgets zie artikel Financiële monitor widgets.

Beschikbare webservices

Op dit moment zijn er negen webservices beschikbaar. Deze webservices bevatten één of meerdere methodes voor de uitwisseling van informatie:

Accounting webservice
- Ophalen van financiële rapportage
- Aanmaken van memoriaalboekingen.
AccountingInfo webservice
- Opvragen informatie over grootboekrekeningen en transacties
Sales webservice
- Aanmaken van verkoopfacturen
Upload webservice
- Aanleveren van documenten
Archive webservice
- Ophalen en insturen van documenten
- Inzage (via app) in het archief.
Contact webservice
- Ophalen van relatiegegevens
- Relatie bijwerken of aanmaken.
PettyCash webservice
- Importeren van kastransacties
Domains webservice
- Aanmaken van actieve en proefdomeinen door accountants
- Ophalen en aanmaken gebruikers in een domein.
Projects webservice
- Aanmaken van nieuwe projecten (dossiers)
- Aanpassen van bestaande projecten (dossiers)
Backoffice webservice
- Controleren van openstaande vragen voor backoffice in administratie
- Ophalen van backoffice workflow van administratie.
- Controleren van specifieke backoffice rollen van portaalgebruikers in domein
- Specifieke backoffice rollen van portaalgebruikers in domein bijwerken.
VAT webservice
- Ophalen van statussen van ingediende btw-aangiften in Yuki (vanuit AdminPulse).
  Voor een uitgebreide beschrijving van de koppeling tussen Yuki en Adminpulse, zie artikel Status ingediende btw-aangifte doorsturen vanuit Yuki.
Purchase webservice
- Aanmaken van inkoopfacturen.

Sourcecode voorbeelden van koppelingen met de Yuki API

Onderaan dit artikel kun je het bestand 'voorbeeldbestanden resultaten webservices.zip' downloaden.

Dit bestand bevat een tiental voorbeelden van XML resultaten die de webservice terug kan geven.

Bijlagen (1)

zip

voorbeeldbes....zip
35 KB