Skip to content

Business Management (1.0.0)

Full-featured B2B API for business operations.

Base URL: https://api.alteg.io/api

⚠️ Version Status

V1 will be gradually deprecated. We recommend using V2 API for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/

Authentication B2B

User authentication and session management for B2B integrations

Operations

Locations

Manage business locations (salons, clinics, etc.)

Operations

Services

Service catalog management including categories and team member assignments

Operations

Team Members

Staff management including positions and scheduling

Operations

Clients

Client database management with comments, files, and visit history

Operations

Users & Permissions

User account management and role-based access control

Operations

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

Products

Product catalog and categories

Operations

Inventory

Stock management, storage operations, and tech cards

Operations

Sales

Sales transactions and document management

Operations

Payments

Payment processing, accounts, and KKM transactions

Operations

Notifications

SMS and email notifications to clients

Operations

Send SMS to the list of clients

Request

The object for creating SMS mailing has the following fields:

FieldTypeDescription
client_idsarray of numbersArray of client IDs
textstringSMS text message
Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
client_idsArray of numbers

Array of client IDs

Example: [1,2,3,4,5]
textstring

SMS text message

Example: "Dear clients, we congratulate you on being our clients! You are very lucky!"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/sms/clients/by_id/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_ids": [
      1,
      2,
      3,
      4,
      5
    ],
    "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
  }'

Responses

Created

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
datastring

Is null

metaobject

An object containing a 201 status code message

Example: {"message":"Accepted"}
Response
application/json
{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}

Send SMS campaigns to customers matching the filters

Request

The object for creating SMS mailing has the following fields:

FieldTypeDescription
textstringSMS text message

Client filtering

  • fullname:'Joh' (optional, string) - Name (part of name) to filter clients
  • phone:'1315' (optional, string) - Phone (part of the number) to filter clients
  • email:'test@' (optional, string) - Email (part) for client filtering
  • card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number

Attention: If there are no filters, SMS mailing will go to the entire database!

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Query
fullnamestring

Name (part of the name) for client filtering

Example: fullname='Joh'
phonestring

Phone (part of the number) for customer filtering

Example: phone='1315'
emailstring

Email (part) for customer filtering

Example: email='test@'
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
textstring

SMS text message

Example: "Dear clients, we congratulate you on being our clients! You are very lucky!"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/sms/clients/by_filter/{location_id}?fullname=%27Joh%27&phone=%271315%27&email=%27test%40%27' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
  }'

Responses

Created

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
datastring

Is null

metaobject

An object containing a 201 status code message

Example: {"message":"Accepted"}
Response
application/json
{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}

Send Email newsletter according to the list of clients

Request

The object for creating an Email campaign has the following fields:

FieldTypeDescription
client_idsarray of numbersArray of client IDs
textstringText Email Message
subjectstringEmail Subject
Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
client_idsArray of numbersrequired

Array of client IDs

Example: [1,2,3,4,5]
subjectstringrequired

Email Subject

Example: "Important!"
textstringrequired

Email text

Example: "Dear clients, we congratulate you on being our clients! You are very lucky!"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/email/clients/by_id/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_ids": [
      1,
      2,
      3,
      4,
      5
    ],
    "subject": "Important!",
    "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
  }'

Responses

Created

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
datastring

Is null

metaobject

An object containing a 201 status code message

Example: {"message":"Accepted"}
Response
application/json
{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}

Online Booking Settings

Configure online booking behavior and forms

Operations

Analytics & Reports

Business analytics, charts, and Z-reports

Operations

Tags

Label management for categorizing entities (deprecated, use v2)

Operations

Deposits

Client deposit accounts and operations

Operations

Loyalty Cards

Loyalty card types, issuance, and manual transactions

Operations

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Salary

Staff salary calculations, payroll, and schemes

Operations

Notification Settings

Configure notification types and user preferences

Custom Fields

Custom field definitions for various entities

Operations

Chain Management

Multi-location chain operations and clients

Operations

Chain Loyalty Programs

Chain-level loyalty programs and transactions

Operations

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations