Getting started with Yuki API
Welcome to the Yuki API! Follow this guide to get up and running with our API, allowing you to integrate seamlessly with our platform and unlock powerful automated capabilities for your financial management needs.
There are two ways to arrive at the Yuki API, and the setup differs enough that each has a guide of its own. Pick the route that describes you below and follow it from start to finish.
Before you start
Whichever route you take, you will need:
- A Yuki portal with at least one company in it. The portal is the accounting office or organization Yuki knows you by, and the companies sit under it and hold the data your application will work with. See Portals and companies if these terms are new to you.
- A user who can sign in to that portal and who looks after integrations for it. This is the person who requests access, creates the application and holds its secret.
- An application you want to connect, and a URL Yuki can return a user to after they sign in. Yuki API is an interactive API, so there is always a signed-in user and your application needs somewhere to receive them.
- A safe place to keep a client secret. A secret is shown only once, at the moment it is created, and it must never be committed to source control or shipped in client-side code.
Which route is right for you?
This is you if you are a Yuki customer and you want to connect your own portal and companies to Yuki — a script, an internal tool or a report that works with your own data and nobody else's.
This is you if you build software that you offer to multiple Yuki customers, where each customer signs in with their own portal and their own companies.
Not sure which one you are?
If neither description fits, or if you think both might, contact Yuki support before you set anything up. It is much easier to start on the right route than to move across later.
Next steps
Now that you know which route to follow, explore the APIs Yuki has and how to integrate with it.
Yuki API rellies on Visma Connect to provide a robust identity and access management platform for secure API authorization.
Yuki supports multiple APIs that support multiple operations from User Provisioning to Domain Management.
Yuki API is in constant evolution providing updated versions that adapt to users needs, but we provide version trackability .