Getting started
Quick start
Create an API key, make your first request to your own workspace address, and learn the response shape.
The Blesyum API is built on a single identity model and a single response contract. Whichever module you call — CRM, ERP, Commerce, B2B, Call Center, Mail, Advisor, Ads — authentication is the same, the error shape is the same, pagination is the same.
1. Create your key
API keys live in the core panel, not in module panels:
Panel → Developer → API Keys → New key
When you create a key you pick its scopes. A scope decides which endpoints that key opens; an endpoint whose scope you did not select returns 403. The scope list narrows to your subscription — a module you are not licensed for never appears.
The secret is shown once. If you lose it you create a new one; there is no way to recover the old key (we cannot see it either — only a digest is stored).
Keys start with the blsk_ prefix.
2. Find your address
Every module has its own address for every workspace:
https://<workspace>.<module>.blesyum.appYou will find your workspace's short name (slug) on the Workspace page in the panel. If you have connected your own domain, that is the module's address — the platform address keeps working but yours is canonical.
| Module | Address |
|---|---|
| CRM | <slug>.crm.blesyum.app |
| ERP | <slug>.erp.blesyum.app |
| Commerce | <slug>.shop.blesyum.app |
| B2B | <slug>.b2b.blesyum.app |
| Call Center | <slug>.call.blesyum.app |
<slug>.mail.blesyum.app | |
| Advisor | <slug>.musavir.blesyum.app |
| Ads | <slug>.ads.blesyum.app |
The bare address without a slug (crm.blesyum.app) is not a sign-in door; it redirects to the product's marketing page. Machine paths (/api/...) still work there, but the product's canonical address is the workspace-specific one.
3. Your first request
curl "https://acme.crm.blesyum.app/api/crm/public/v1/contacts?per_page=5" \
-H "Authorization: Bearer blsk_..." \
-H "Accept: application/json"Response:
{
"type": "list",
"data": [
{ "type": "contact", "id": "0193…", "name": "Jane Doe", "email": "jane@example.com" }
],
"pages": { "type": "pages", "per_page": 5, "next": { "starting_after": "eyJ…" } }
}The workspace is resolved from the key, not from the address. A key only ever sees its own workspace; even if you send a request to the wrong host you cannot reach another tenant's data.
4. Next
- Authentication — which credential, when
- Requests and responses — envelope, error codes,
trace_id - Pagination — how the signed cursor works
- Webhooks — receive events on your own server
- MCP server — let your AI read this API itself