Skip to content
/
Get a list of card types...

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

Get User Loyalty Cards

Request

Returns a list of cards of an authorized user with programs, filtering cards by location chain / location

Security
BearerPartner
Path
chain_idnumberrequired

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/user/loyalty_cards/{chain_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
idinteger(int32)

Loyalty card ID

Example: 9210520
balancenumber(float)

Loyalty card balance

Example: 100
pointsinteger(int32)
paid_amountnumber(float)

Amount Paid

Example: 1000
sold_amountnumber(float)

Amount "Sold"

Example: 1000
visits_countinteger(int32)

Number of visits

Example: 1
numberstring

Card number

Example: 14507109210520
type_idinteger(int32)

Loyalty card type identifier

Example: 10992
salon_group_idinteger(int32)

ID of the chain where the card was created

Example: 145071
typeobject

An object that contains the "id" and "title" fields: card type identifier and card type name, respectively

Example: {"id":10992,"title":"5+2","salon_group_id":145071}
salon_groupobject

An object that contains the "id" and "title" fields: the identifier of the chain where the card type was created and the name of this chain

Example: {"id":145071,"title":"Dough chain1."}
programsArray of objects

An array with information about promotions linked to a loyalty card

Example: [{"id":18005,"title":"5+2","value":0,"loyalty_type_id":13,"item_type_id":3,"value_unit_id":1,"group_id":145071,"loyalty_type":{"id":13,"title":"Discount for a given number of accumulated services","is_discount":true,"is_cashback":false,"is_static":false,"is_accumulative":false},"rules":[{"id":72803,"loyalty_program_id":18005,"loyalty_type_id":13,"value":20,"parameter":0},{"id":72804,"loyalty_program_id":18005,"loyalty_type_id":13,"value":10,"parameter":0},{"id":72805,"loyalty_program_id":18005,"loyalty_type_id":13,"value":100,"parameter":0}]}]
Response
application/json
{
  "id": 9210520,
  "balance": 100,
  "points": 0,
  "paid_amount": 1000,
  "sold_amount": 1000,
  "visits_count": 1,
  "number": 14507109210520,
  "type_id": 10992,
  "salon_group_id": 145071,
  "type": {
    "id": 10992,
    "title": "5+2",
    "salon_group_id": 145071
  },
  "salon_group": {
    "id": 145071,
    "title": "Dough chain1."
  },
  "programs": [
    { … }
  ]
}

Get a list of card types available at the location

Request

Returns a list of card types that are valid for the given location.

The attributes and their descriptions match those defined in the "Collection of Card Types Available to the Client" method described above.

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Example: 12345
Headers
Acceptstringrequired

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

Example: application/vnd.api.v2+json
curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/card_types/salon/12345 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int32)

Card type identifier

titlestring

Card type name

salon_group_idinteger(int32)

ID of the chain where the card type was created

salon_groupobject

An object that contains the "id" and "title" fields: the identifier of the chain where the card type was created and the name of this chain

]
Response
application/json
[
  {
    "id": 10992,
    "title": "Cashback",
    "salon_group_id": 145071,
    "salon_group": { … }
  },
  {
    "id": 8230,
    "title": "Referral program",
    "salon_group_id": 145071,
    "salon_group": { … }
  }
]

Get a List of Card Types Available for Issuance to the Client

Request

Returns a list of card types that are available for issuance to a location client.

AttributeTypeDescription
idintCard type identifier
titlestringCard type name
salon_group_idintID of the chain where the card type was created
salon_groupobjectAn object that contains the "id" and "title" fields: identifier of the chain where the card type was created and the name of this chain
Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Example: 12345
phonenumberrequired

Customer phone number

Example: 13155550175
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/loyalty/card_types/client/12345/13155550175 \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int32)

Card type identifier

titlestring

Card type name

salon_group_idinteger(int32)

ID of the chain where the card type was created

salon_groupobject

An object that contains the "id" and "title" fields: the identifier of the chain where the card type was created and the name of this chain

]
Response
application/json
[
  {
    "id": 10992,
    "title": "Cashback",
    "salon_group_id": 145071,
    "salon_group": { … }
  },
  {
    "id": 8230,
    "title": "Referral program",
    "salon_group_id": 145071,
    "salon_group": { … }
  }
]

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