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.


Om een extern systeem toegang te geven tot informatie die in Yuki staat kun je een webservice-toegangscode (laten) genereren waarmee zo'n systeem ook zonder inloggen toegang heeft. 

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


AANDACHT!

Voor jouw veiligheid verbetert Yuki vanaf 1 april 2019 haar SOAP-webservices beveiliging. 

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 of twijfel je? Contacteer dan even je software partner, deze kan je zeker helpen. Bij verdere vragen kan je software partner een e-mail sturen naar support@yuki.nl.


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 verkoopfacturen
  • Aanmaken van memoriaalboekingen
  • 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.


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


De module Webservice of Webservice Plus is alleen beschikbaar wanneer deze in een domein met een Basis of Plus licentie door het administratiekantoor/accountant is geactiveerd.

De module Webservice of Webservice Plus is alleen beschikbaar wanneer deze in een domein met Yuki Financieel door een gebruiker met de rol 'Directie' is geactiveerd via de Yuki store op de desktop in het domein.


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 acht 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
    • Inzicht (via app) in het archief.
  • Contact webservice
    • Ophalen van contact gegevens
    • Contact bijwerken of aanmaken
  • PettyCash webservice
    • Importeren van kastransacties
  • Domains webservice
    • Aanmaken van actieve en proefdomeinen door accountants
    • Ophalen en aanmaken gebruikers in een domein.


TIP!

Bij het aanleveren van verkoopfacturen vanuit een Webshop (via de Sales webservice) moet aandacht worden besteed aan de grootboekrekening en de prijzen.


Sourcecode voorbeelden van koppelingen met de Yuki API



Onderaan deze pagina kun je het bestand 'voorbeeldbestanden resultaten webservices.zip' downloaden.

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