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. 

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.

LET OP!

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.

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. 

TIP!

Elk domein heeft standaard 1000 calls per dag beschikbaar voor de webservices. Indien het aantal calls per dag hoger is dan dit aantal moet de accountant via de Yuki Store in het domein het feature Yuki Webservice (vanaf 1000 tot maximaal 5000 calls per dag) of Yuki Webservice Plus (vanaf 5000 tot maximaal 10.000 calls per dag) activeren.

In een bundle pricing domein moet één van beide features als accountant feature aan het contract van het domein worden toegevoegd.

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!

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

• Financieel:
  • Accounting webservice:
    • Ophalen van financiële rapportage
    • Aanmaken van memoriaalboekingen
  • AccountingInfo webservice:
    •  Opvragen informatie over grootboekrekeningen en transacties
• Archief (Archive webservice):
  • Ophalen en insturen van documenten
  • Inzage (via app) in het archief.
• Verkoop (Sales webservice):
  • Aanmaken van verkoopfacturen (UBL)
• Workflow (Upload webservice):
  • Aanleveren van documenten
• Kas (PettyCash webservice):
  • Importeren van kastransacties
• UBL:
  • Exporteren van UBL facturen
• Relaties (alleen lezen) (Contact webservice):
  • Ophalen van relatiegegevens
• Relaties (Contact webservice);
  • Aanmaken of bijwerken van relatie
• Projecten (Projects webservice):
  • Aanmaken van nieuwe projecten (dossiers)
  • Aanpassen van bestaande projecten (dossiers).

• Backoffice (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.
• Btw (VAT webservice):
  • Automatisch 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.
• Inkoop (Purchase webservice):
  • Aanmaken van inkoopfacturen.

LET OP!

• 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. 
• In een Minimal versie van Yuki kan het administratiekantoor/accountant via je contract het feature Sales webservice in je domein toevoegen.