Getting Started
Getting Started
Choose an integration mode and reach a successful request quickly
Decide what you are building before you pick endpoints.
"Partner" is a credential scope: partner credentials define which managed teams you can access, not how you build. A partner can build a custom UI, embed VRPlatform, integrate data, operate webhooks, or combine those modes.
| Goal | Start here | Credential used by your backend |
|---|---|---|
| Build your own product UI | Build a Product UI | Team or partner API key |
| Embed VRPlatform-hosted UI | Embed the Hosted UI | Partner API key |
| Submit or migrate source data | Integrate & Migrate Data | Team or partner API key |
| Keep an integration healthy | Run in Production | Team or partner API key |
| Call exact operations | API Reference | Depends on operation |
| Connect an AI assistant | MCP | OAuth or API key |
Every path shares the same foundations:
- use the public base URLs;
- send the matching credential;
- establish team context;
- make a first read; and
- validate a first mutation before applying it.
The generated API Reference holds the exact request and response schemas; the task guides show how to use them. Before building accounting flows, read Core Concepts to understand the double-entry model, locking, and statements.