Overview
Build server-side integrations with the Orvelt Business API and TypeScript SDK.
Use these docs to connect your service to Orvelt Business. You can start with the generated TypeScript SDK, call the REST API with cURL, or use the endpoint reference to inspect every public operation.
Get started
Install the SDK, configure authentication, and send your first request.
Guides
Complete integration tasks grouped by feedback, reviews, delivery, and automation.
TypeScript SDK
Configure @orvelt/business and handle typed responses.
API reference
Review conventions, every operation, errors, limits, and troubleshooting.
Choose a starting point
Match the path to your job
- You are building your first integration: follow Get started.
- You already have a server application: configure the SDK, then read response handling.
- You need to complete one business task: choose a guide in Guides.
- You need exact fields or permissions: open the API reference.
API examples
Compare generated and direct requests
Each API request in these docs shows the TypeScript SDK request first and the equivalent cURL request second. The examples use placeholders such as PROJECT_ID and YOUR_API_KEY; replace them with values from your environment.
Keep API keys on the server
The x-api-key value grants access to business data. Read Authentication before adding a request to your application, and never ship the key in browser code.
Public API surface
Browse operations by job
The public API is generated from the Business contract and published through @orvelt/business. The reference groups operations by the job they support: analytics, feedback configuration, review data, delivery links, subscribers, knowledge-base content, and webhooks.