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.
De WebserviceAccessKey (webservice API-sleutel) wordt gebruikt om webservice toegang te verlenen op portaal-,  domein- of administratieniveau.


TIP!

Vertrouw je de beveiliging van de API-sleutel niet meer, genereer dan een nieuwe API-sleutel. Kopieer vervolgens de API-sleutel om deze in je toepassing te gebruiken.


Alleen een gebruiker met de rol 'Portaalbeheerder' kan d.m.v. de webservice API-sleutel de (toegangs)rechten tot webservices in het portaal instellen

Deze gelden dan voor alle domeinen en administraties waartoe de portaalbeheerder toegang heeft.


Een gebruiker met de rol 'Portaal backoffice' heeft geen toegang tot de instellingen van de webservices.


Vanuit dit scherm kan een gebruiker met de rol 'Portaalbeheerder':

  • een nieuwe API-sleutel toevoegen
  • de webservice aanroepen bekijken
  • de gegevens van een API-sleutel bekijken
  • de webservice van een API-sleutel wijzigen
  • een API-sleutel verwijderen.


In het backoffice portaal klik je rechtsboven in je scherm op het icoon Instellingen.

 


Klik vervolgens in het nu geopende scherm op Webservices.


Het volgende scherm wordt geopend:



Nieuwe API-sleutel toevoegen

Om voor het portaal de webservices te activeren en een toegangscode te genereren, klik je op de knop Voeg nieuwe API-sleutel toe.


Het volgende scherm wordt geopend:



Kies vervolgens de (toegangs)rechten voor de gewenste webservices en klik op de knop Bewaren


De nieuwe API-sleutel is toegevoegd.



Je kunt (toegangs)rechten tot de volgende webservices selecteren:


LET OP!

Bij het aanleveren van verkoopfacturen vanuit 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.


Webservice aanroepen bekijken

Om het aantal webservice aanroepen (calls) te bekijken, klik je op de knop Webservice aanroepen.



Elk domein heeft standaard 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 1000 tot maximaal 5000 calls per dag)
  • Yuki Webservice Uitgebreid (vanaf 5000 tot maximaal 10.000 calls per dag).

Gegevens van API-sleutel bekijken

Om de gegevens van een API-sleutel te bekijken, beweeg je met je muis boven de regel van de desbetreffende API-sleutel, klik je op de knop met de drie puntjes en selecteer je vervolgens Bekijk API-sleutel gegevens in het dropdownmenu.



Voor een uitgebreide beschrijving zie artikel Webservice API-sleutel gegevens bekijken en/of wijzigen.


Webservice(s) van API-sleutel wijzigen

Om de gegevens van een API-sleutel te wijzigen, beweeg je met je muis boven de regel van de desbetreffende API-sleutel, klik je op de knop met de drie puntjes en selecteer je vervolgens Wijzig webservice API-sleutel in het dropdownmenu.



Voor een uitgebreide beschrijving zie artikel Webservice API-sleutel gegevens bekijken en/of wijzigen.


API-sleutel verwijderen

Om een API-sleutel te verwijderen, beweeg je met je muis boven de regel van de desbetreffende API-sleutel, klik je op de knop met de drie puntjes en selecteer je vervolgens Verwijderen in het dropdownmenu.