One of the advantages of Yuki is that you will be able to connect to different kind of software packages. This will give you the chance to automate the import of invoices or export data for reporting.
To make the connection with the external software you will need an API key and a Company ID. Those two codes will give access to a Yuki-domain. Only the accountant with the role “Portal administrator” or a user with the role “Director” will be able to retrieve the codes.
As an accountant you can also create an API key for access to all your domains.
Are you a developer or looking for the technical details to develop a connection? Click here for all the needed information.
Where can I find my API-key? (domain)
An accountant with the role “Portal administrator” or a user with the role “Director” can generate an API-key in a Yuki Domain. Therefore go to your icon on the left upper corner and go to Settings. There you will find a button "Web services".
On the bar above you find the “plus” sign to add a new API-key. We suggest to set the Type as “Company”, therefore the Company ID will also be visible.
If you have multiple companies in your domain, select one of the companies. You can create an API key for each of your companies.
You can find also the Company ID in the URL: go to 'My domain', right-click on your administration and open in a new tab. In the URL you can find the comany ID
You also have the choice to change the webservices your API key has access to. We only advice you to select a specifc webservice if you are building your own connection. If you want to connect to an existing software solutions we prefer to select "All webservices". For example in case of an Invoicing solution, the software might both send invoice through the Sales Webservice as calling the payment status with the Accounting Webservice.
Press the Save button to see the API-key and the according Company ID. Those you can copy to add in your other software solution to finalize the connection.
Where can I find my API-key? (Portal)
As an accountant you can also create an API key for all your domains in your portal. Only a backoffice employee with the role 'Backoffice Administrator' can create an API key. You will find the Webservices at your Settings. Then follow the same steps as above.
- If you want to connect multiple companies, you will have to create an API key for each of the companies.
- Make sure you don’t mix up the keys and company IDs, otherwise the connection will not work.
- In the external software solutions, you will often see the field “Access key”. This is where you enter the API key.
From the 1st of April 2019, Yuki will improve her SOAP-webservice security for your safety.
Our connections will only accept connections with security TLS 1.2 and higher. This shouldn't have any impact on most connection implementations (applications who are connected with Yuki to send data to Yuki or export data from Yuki).
Still any questions or doubts? Please contact your software partner, they should be able to help you. For further questions your software partner can send us an email at firstname.lastname@example.org.