Connecting Yuki

Prerequisites

• A Yuki account on any bundle. Yuki's bundles are Minimal (free), Small, Medium, Large and Unlimited. There is no API-specific plan: web service access is available on top of every bundle, including the free Minimal tier.
• Web service access activated on your domain. This is a feature your accountant or administrative office switches on for you, not something you can enable yourself. If it is not active yet, ask them to activate web service access before you start.
• On the free Minimal bundle, ask them to add the Sales web service too — it is a separate accountant feature there.
• A user with the Portal administrator or Management role. Only those roles can create a web service key and set its access rights.
• Your Yuki administration ID (a GUID).

Steps

1. Create your API key (WebserviceAccessKey)

   • Sign in to Yuki at yuki.nl or yuki.be.
   • Open Settings (the icon in the top right of the portal), then Web services.
   • Add a new API key, or copy an existing one. A Portal administrator can also review web service calls from this screen.
   • Grant the key access to the web services you need. Access can be given at portal, domain or administration level, and a key can be scoped to individual web services. Domain and administration rights overrule portal-level rights, so check the level you actually granted.
   • Vendor instructions: Web service access code (Netherlands) or Web service access key (Belgium).

2. Find your Administration ID

   • It is a GUID, for example a1b2c3d4-e5f6-7890-abcd-ef1234567890.
   • Your Yuki administrator can supply it. If nobody in your organisation knows it, ask Yuki support.

3. (Optional) Find your Domain ID

   • Only the customer and supplier operations use this value. Every other operation ignores it.
   • When it is left empty, those operations fall back to the Administration ID, which is correct for most setups. Fill it in when your Yuki domain GUID differs from your administration GUID.
   • Your Yuki administrator can supply it.

4. Connect in Apideck Vault

   • Enter your API Key (the WebserviceAccessKey from step 1).
   • Enter your Administration ID.
   • Optionally enter your Domain ID.
   • Select your Region: Netherlands or Belgium.
   • Save the connection.

Settings

Setting	Required	Description
API Key	Yes	Your WebserviceAccessKey, created under Settings > Web services in the Yuki portal
Administration ID	Yes	The GUID of the Yuki administration to connect
Domain ID	No	GUID of the Yuki domain. Used only by the customer and supplier operations; falls back to the Administration ID when left empty
Region	Yes	Netherlands (api.yukiworks.nl) or Belgium (api.yukiworks.be)

Notes

• The connector authenticates before every operation. It opens a Yuki session immediately before each request rather than reusing one across calls. Yuki does not document whether that session call counts towards your daily web service call allowance, so plan your call volume conservatively and monitor usage on the Settings > Web services screen.
• Higher call volumes are an accountant action. If you outgrow your domain's included daily allowance, your accountant or administrative office activates a paid web service add-on on the domain. You cannot add it from your own account.
• TLS 1.2 or higher is required for all Yuki web service traffic.

Troubleshooting

Issue	Solution
"Authentication failed"	Check the API key was copied in full and is still active in Settings > Web services. Confirm the key is scoped to the web service the operation uses, and remember that domain and administration rights overrule portal-level rights.
403 / Forbidden	Ask your accountant or administrative office to confirm web service access is activated on the domain. On the free Minimal bundle, also confirm the Sales web service has been added.
"No data returned"	Confirm the Administration ID matches an active administration, and that the selected administration actually holds data (invoices, contacts and so on).
Wrong or missing data on customers and suppliers	Those operations are the only ones that use the Domain ID. Set it explicitly when your domain GUID differs from your administration GUID.
Customer or supplier list is empty despite contacts existing in Yuki	Observed behaviour with this connector: contacts can be present in Yuki without appearing in the customer or supplier list. Creating an invoice for the contact has been seen to make it appear. Yuki does not document this, so if the list stays empty, check the contact's type in Yuki and contact Apideck Support with an example contact.
Calls start failing after working fine	You may have reached your domain's daily web service call allowance. Check usage under Settings > Web services and ask your accountant about a higher allowance.

Need help? Contact Apideck Support.