Developer CenterAPI & integrations

Brilliance One · Developer platform

Build on one connected business platform.

Explore the Brilliance One API for CRM, ERP, CMS, scheduling, inventory, communications, and automation. Find current endpoint contracts, integration guidance, and developer SDK resources.

API base URL: https://api.brillianceone.com · Canonical schema: OpenAPI v1 JSON

Developer resources

Use the deployed OpenAPI document as the authoritative contract. Interactive docs reflect the current deployed API after page refresh; generated SDK archives are separate release artifacts.

Live reference

Interactive API Reference

Search endpoints, explore schemas, view C# HttpClient requests, and test calls using credentials you provide.

Open Scalar documentation ↗
Machine-readable

OpenAPI contract

Read the current production API specification used by client generators and integration tooling.

View OpenAPI JSON ↗
Platform

Brilliance One Website

Discover the CRM, ERP, and business operating system modules available for customer implementations.

Visit Brilliance One ↗

Developer SDKs

C# is our primary client language. Source archives for other languages can be generated with Microsoft Kiota. Downloads become visible only when the matching ZIP is actually published on this site; generated code should be compiled and tested before production use.

Primary SDK

C# / .NET

Enterprise integrations, ASP.NET Core applications, Windows services, and Microsoft ecosystems.

Checking availability…
Server-side

TypeScript

Node.js backends and typed JavaScript integrations. Keep API credentials on trusted servers.

Checking availability…
Automation & AI

Python

Data pipelines, reporting, integrations, and automated business workflows.

Checking availability…
CMS integrations

PHP

Server-side CMS integrations, WordPress extensions, and web agency projects.

Checking availability…
Enterprise

Java

JVM-based business systems and enterprise middleware integrations.

Checking availability…
Infrastructure

Go

Efficient backend services, automation tools, and integration workers.

Checking availability…

Source archives are not published NuGet/npm/PyPI/Composer/Maven/Go module packages or a guarantee of SDK compatibility. Production integration requires testing against your account and permissions.

Getting started

Brilliance One uses a tenant-aware API security model. Begin with the live documentation, then authenticate for the specific endpoint you're calling.

1. Discover the operation

Browse the interactive reference, inspect the request model, and check authorization requirements and rate limits for your operation.

2. Authenticate appropriately

Most tenant-aware public content calls require a valid tenant API key. Protected user operations require an API key and an authenticated bearer user with sufficient tenant permissions. A few truly global endpoints may require neither.

3. Handle responses

Check HTTP status, documented response schemas, request correlation IDs, and Retry-After on rate-limited calls when present.

API request example

Example only: use credentials issued to your integration and never embed them in browser JavaScript or public repositories.

using var client = new HttpClient();
using var request = new HttpRequestMessage(
    HttpMethod.Get,
    "https://api.brillianceone.com/api/v1/auth/me");

request.Headers.Add("X-API-Key", apiKey);
request.Headers.Authorization =
    new System.Net.Http.Headers.AuthenticationHeaderValue(
        "Bearer", accessToken);

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

Obtain apiKey and accessToken securely. The example calls a protected operation and intentionally excludes token acquisition code.

Integration guides

Start with these concepts, then consult each operation's precise contract in the live API reference.

Authentication and tenant isolation

Use the API key assigned to your tenant; use a bearer token for user-authenticated operations. Keep credentials server-side, use least privilege, validate authorization failures, and never send credentials to logs or front-end bundles. The tenant resolved from the API key must match the authorized user context.

Pagination and filtering

Grid endpoints may accept PageNumber, PageSize, SearchText, SortColumn, and SortDirection. Not all older collections use the same pagination response yet: rely on each endpoint's current OpenAPI schema.

Rate limits and retry behavior

Respect HTTP 429 responses; use Retry-After when present and exponential backoff with jitter. Avoid repeated polling, parallel bursts, and retry storms. Do not assume that every endpoint has the same per-minute limit.

Errors, tracing, and troubleshooting

Distinguish HTTP 400, 401, 403, 404, 429, and 5xx responses. Capture a request/trace identifier when available and provide it to support. Error response bodies can vary by endpoint and middleware; always check the real HTTP response.

SDK generation and releases

SDK sources can be generated with Microsoft Kiota. Re-generate and validate them when the API contract changes. Live documentation tracks the deployed contract; source ZIPs are release artifacts and do not update automatically.

Need help integrating?

Review Brilliance One's supported business modules, licensing information, and contact options. For technical troubleshooting, include the operation name, HTTP status, API version, and trace ID—never send API keys or bearer tokens.