Yurbi API — Introduction

Embed analytics, manage users and access, and automate your Yurbi instance — all over a simple JSON API that runs entirely on your own servers.

What the Yurbi API is

The Yurbi API lets your application drive a Yurbi instance programmatically: authenticate users, create and manage users and groups, configure data security, run reports, and embed dashboards directly in your product. It runs on your own Yurbi server — no data leaves your infrastructure.

The API is intentionally simple:

• One transport. Every endpoint is an HTTP POST that accepts and returns JSON.
• One base path. All endpoints live under https://your-yurbi-server.com/api/....
• One auth model. You log in once to get a session token, then pass that token on every other call.

What you can do with it

• Embed analytics — drop a Yurbi dashboard or report into your own app, branded as yours, scoped to each customer's data. See the Embedding guide.
• Single sign-on — sign users in with no second login using a session token. See Single Sign-On.
• Provision access — create users, build security groups, and assign roles so each customer sees only what they should.
• Enforce isolation — attach groups to AppShield data-security policies.
• Automate operations — configure email, instance settings, and licensing as part of your own deployment pipeline.

Where to go next

1. Quickstart — make your first successful call in a few minutes.
2. Authentication & sessions — how tokens work and stay alive.
3. Conventions & errors — the patterns shared across every endpoint.
4. API Reference — every endpoint, with live, runnable examples.

The Reference page has a built-in "Try it": enter your server's Base URL and a token, edit any request, and send it live (or copy a ready-to-run cURL).