Set up web services in domain and/or administration

Disclaimer

All screenshots in the article were taken in the Dutch version of Yuki.

A web service contains one or more methods for the exchange of information with applications/services of external parties. Just think of financial data, submitting data of sales invoices and access and/or upload to the Yuki archive. 

Web services

By default, each domain has 1,000 web service calls (calls) per day available for free.

To increase the number of available web service calls, a user with the “Portal administrator” role has the option to add one of the following accountant features to the domain: 

• Yuki Webservice (from 1,000 to a maximum of 5,000 calls per day)
• Yuki Webservice Extended (from 5,000 to a maximum of 10,000 calls per day).

For a description of all the available web services in Yuki, see article Yuki API link.

ATTENTION!

• In a domain with the Minimal version of Yuki, the Sales web service (1,000 calls per day) must be added to the domain as an accountant feature. In all other bundles, the Sales web service is included for free.
• To use the Purchase web service, a formal request must be sent by email to support@yuki.nl.
  You will then receive a Client ID/Secret by email from Yuki. You will need this in addition to the API key for authentication in order to gain access to the Purchase web service.
• When submitting sales invoices from, for example, a Webshop, the Invoicing (old Sales) or Small, Medium, Large or Unlimited bundle must have been selected by a user with the 'Management' role via the Yuki Store in the domain because based on the data from the link, sales invoices are generated and processed in Yuki.

Web service links access

If the software you want to link with already has a link, some settings need to be defined in that software or with the third-party provider of the link. 

To give external software access to information in Yuki, you have to generate a web service API key and Administration ID (or have it generated) in Yuki with which the external software can access a Yuki domain without logging in.

The (access) rights to webservices in a domain or administration are leading and 'overrule' the (access) rights to web services as they are set on portal level.

Only a user with a 'Back office' role in the domain or the role 'Management' can set (access) rights to web services in the domain and/or administration(s) by means of the web service API key and Administration ID. 

All configured settings such as the settings of the web services, among others, are grouped and categorised in one place in your domain.

Generate web service API key (WebserviceAccessKey) and Administration ID

The web service API key and Administration ID can be generated from different places in Yuki:

• Click on the Switch domain icon above the navigation bar and then click on My domain. Click on the administration name and then, in the now-opened screen, click on Web services.
• Hover your mouse over the Home icon in the navigation bar, click on the My domain tile and then on click the administration name.
  In the now-opened screen click on Web services.
• Click on the Settings icon in the navigation bar and then, in the now-opened screen, click on Web services.

The following screen is opened:

In this screen click on the + button in order to activate the web services in the domain or the administration and generate a web service API key. 

The following screen is opened:

Specify here whether you want to generate a web service API key for a 'Domain' or an 'Administration' (select the correct administration), select the web services (all web services or a selection thereof) for which you to grant (access) rights and then click on the Save button.

TIP!

Only select specific web services to which you want to grant access when building your own link. If you want to link to existing software then select 'All web services'.

Copy the API key and/or administration ID in order to use it in your application. In many software applications, the 'Access code' field is present.

ATTENTION!

• If you want to link multiple administrations, you need to create multiple web service API keys.
• Do not swap API keys, or the link will not work.

If you no longer trust the security of the API key, generate a new one!