Webservices in domein en/of administratie instellen

Een webservice bevat één of meerdere methodes voor de uitwisseling van informatie met applicaties/diensten van externe partijen. Je kunt hierbij o.a. denken aan financiële gegevens, aanleveren van gegevens van verkoopfacturen en het benaderen van en uploaden naar het Yuki archief. 

Webservice koppelingen

Elk domein heeft standaard gratis 1000 webservice aanroepen (calls) per dag beschikbaar.

Om het aantal beschikbare webservice aanroepen (calls) te verhogen, heeft een gebruiker met de rol 'Portaalbeheerder' de mogelijkheid om één van de volgende accountant features aan het domein toe te voegen: 

• Yuki Webservice (vanaf 1.000 tot maximaal 5000 calls per dag)
• Yuki Webservice Uitgebreid (vanaf 5.000 tot maximaal 10.000 calls per dag).

Voor een beschrijving van alle beschikbare webservices in Yuki zie artikel Yuki API koppeling. 

LET OP!

• In een domein  met de Minimal versie van Yuki moet de Sales webservice (1.000 calls per dag) als accountant feature aan het domein worden toegevoegd. In alle andere bundels is de Sales webservice gratis inbegrepen.
• Om gebruik te kunnen maken van de Purchase webservice moet per e-mail een formeel verzoek worden verstuurd naar [email protected]
  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.
• Bij het aanleveren van verkoopfacturen vanuit bijv. een Webshop moet de Facturatie (oude Verkoop) oftewel de bundel Small, Medium, Large of Unlimited door een gebruiker met de rol 'Directie' zijn gekozen via de Yuki Store in het domein omdat op basis van de data vanuit de koppeling de verkoopfacturen in Yuki worden gegenereerd en verwerkt.

Toegang webservice koppelingen

Als het software pakket waarmee je wilt koppelen al een koppeling heeft, dan moeten een aantal instellingen vastgelegd worden in die software 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.

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.

Alleen een gebruiker met een 'Backoffice' rol in het domein of de rol 'Directie' kan d.m.v. de webservice API-sleutel en Administratie-ID de (toegangs)rechten tot webservices in het domein en/of de administratie(s) instellen. 

Alle vastgelegde instellingen zoals o.a. de instellingen van de webservices zijn op één plaats in je domein samengebracht en gecategoriseerd.

Webservice API-sleutel (WebserviceAccessKey) en Administratie-ID genereren

De webservice API-sleutel en Administratie-ID kunnen vanuit verschillende plaatsen in Yuki worden gegenereerd:

• Klik boven de navigatiebalk op het icoon Wissel domein en vervolgens op Mijn domein. Klik op de naam van de administratie. Klik in het nu geopende scherm op Webservices.
• Klik in de navigatiebalk op het icoon Start en vervolgens op de tegel Mijn domein. Klik op de naam van de administratie. Klik in het nu geopende scherm op Webservices.
• Klik in de navigatiebalk op het icoon Instellingen en vervolgens in het nu geopende scherm op Webservices.
  
  

Het volgende scherm wordt geopend:

Klik op de knop + om voor het domein of de administratie de webservices te activeren en een webservice API-sleutel te genereren.

Het volgende scherm wordt geopend:

Geef hier aan of je een webservice API-sleutel wilt genereren voor een 'Domein' of een 'Administratie' (selecteer ook de juiste administratie), selecteer tot welke webservices je (toegangs)rechten wilt verlenen (alle webservices of een selectie daarvan) en klik op de knop Bewaren.

TIP!

Selecteer alleen specifieke webservices tot welke je toegang wilt verlenen wanneer je zelf een koppeling bouwt. Wil je een koppeling leggen met een bestaand software pakket dan selecteer je 'Alle webservices'.

Kopieer vervolgens de API-sleutel en/of de Administratie-ID om deze in je toepassing te gebruiken. In veel software pakketten is het veld 'Toegangscode' aanwezig. 

LET OP!

• Wil je meerdere administraties koppelen dan moet je meerdere webservice API-sleutels aanmaken.
• Wissel de API-sleutels zeker niet om, dan werkt de koppeling niet.

Vertrouw je de beveiliging van de API-sleutel niet meer, genereer dan een nieuwe!