Introduction for developers

This section covers everything you need to integrate with Solvimon: authentication, error handling, idempotency, webhooks, and HTTP conventions.

First time integrating? Get an API key (Authentication), then follow the API quickstart to make your first request against the test environment.

The four APIs

Solvimon exposes four separate APIs. Most integrations use all four.

API	Base path	What it’s for
Configuration API	`/v1/`	Create and manage meters, products, pricing plans, features
Identity API	`/v1/`	Create and manage customers, subscriptions
Transaction API	`/v1/`	Invoices, payments, credit notes
Event API	`/v1/`	Ingest usage events

Full endpoint reference is in the API Docs tab.

Environments

Environment	API base URL	Desk URL
Test	https://test.api.solvimon.com/v1/	https://test.desk.solvimon.com
Production	https://api.solvimon.com/v1/	https://desk.solvimon.com

Test and production are fully isolated. Test keys will not work against the production endpoint and vice versa. Data created in one environment never appears in the other.

Request conventions

Every request requires:

Content-Type: application/json
X-API-KEY: <your_key> – see Authentication
HTTPS – plain HTTP requests are rejected

Every response includes an X-REQUEST-ID header. Save this value when debugging; it’s required when contacting support about a specific request.

Start here

Create an API key and use it to authenticate requests in each environment.

Local development setup

Configure your local environment to make API calls and receive webhooks during development.

HTTP response codes, error payloads, and what each error code means.

Troubleshooting

Common errors during integration and how to resolve them.

Build a robust integration

Safely retry requests without risking duplicate operations.

Receive real-time notifications when resources change, with at-least-once delivery.

Recommended client-side timeout settings for resilient API calls.

Developing for Solvimon

Build your integration with AI coding agents: llms.txt, the Solvimon skill, and the Solvimon MCP server with its full tool reference.

API conventions

Query parameters

Filter, order, and paginate list responses.

Expanding responses

Request related objects inline instead of fetching them by ID.

Timestamp formatting

ISO 8601 requirements for timestamps, especially when ingesting events.

Supported locales for customer-facing documents and communication.