Skip to content
/
Get a List of Chain Loyal...

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

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

Delete Chain Promotion

Request

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

loyalty_program_idintegerrequired

Promotion ID

Query
includestring

Include additional resources in the answer

Enum"applicable_items""rules""companies""loyalty_card_types""on_changed_notification_template""on_expiration_notification_template"
curl -i -X DELETE \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/{chain_id}/loyalty/programs/{loyalty_program_id}?include=applicable_items' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

No content

Response
No content

Get a List of Chain Loyalty Transactions

Request

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Query
created_afterstring(date)required

Sample start date in Y-m-d format

created_beforestring(date)required

Sample end date in Y-m-d format

typesArray of strings

Types of loyalty transactions included in the selection: 1 - Promotion discount, 2 - Loyalty program accrual, 3 - Loyalty card withdrawal, 4 - Referral program accrual, 5 - Manual replenishment, 6 - Manual withdrawal, 7 - Overdue points withdrawal , 8 - Withdrawal from the gift card, 9 - Use of the membership, 10 - Recalculation of the cost of the membership, 11 - Withdrawal from the client account

Items Enum"1""2""3""4""5""6""7""8""9""10"
company_idsArray of integers

Loyalty transaction affiliate IDs included in the sample

visit_idsArray of integers

Loyalty transaction visit IDs included in the sample

pageinteger

Selection page

countinteger

Number of results per selection page

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/{chain_id}/loyalty/transactions?created_after=2019-08-24&created_before=2019-08-24&types=1&company_ids=0&visit_ids=0&page=0&count=0' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

dataArray of objects

Array of objects with data

metaobject

Metadata (contains the number of items in the response)

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 0
  }
}

Get a list of loyalty notification templates

Request

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/{chain_id}/loyalty/notification_message_templates/programs' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int32)

Template ID

Example: 12
typestring

Template option

Enum"big""mid""small""custom"
Example: "small"
bodystring

Template text

Example: "Your discount expires tomorrow"
message_typestring

Message type

Enum"loyalty_discount_expiration""loyalty_cashback_expiration""loyalty_discount_increased""loyalty_discount_decreased""loyalty_card_created""loyalty_card_withdraw""loyalty_withdraw_cancelled""loyalty_card_manual""loyalty_card_manual_withdraw""loyalty_card_cashback"
Example: "loyalty_discount_expiration"
]
Response
application/json
[
  {
    "id": 12,
    "type": "small",
    "message_type": "loyalty_discount_expiration",
    "body": "Your discount expires tomorrow"
  }
]

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations