User authentication and session management for B2B integrations
- Get User Loyalty Cards
Get a List of Customer Cards by ID
Get a List of Customer Cards by Phone Number
Get a list of card types available at the location
Get a List of Card Types Available for Issuance to the Client
Get a List of Card Types Available at the Chain
Issue a Loyalty Card
Remove a Loyalty Card
Manual withdraw/deposit to loyalty card in location
Manual withdraw/deposit to loyalty card in chain
Get User Loyalty Cards
Business Management (1.0.0)
Full-featured B2B API for business operations.
Base URL: https://api.alteg.io/api
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/
Request
Returns a list of customer cards with programs that are active in this location
| Attribute | Type | Description |
|---|---|---|
| id | int | Loyalty card ID |
| balance | decimal | Loyalty card balance |
| paid_amount | decimal | Amount "Paid" |
| sold_amount | decimal | Amount "Sold" |
| visits_count | int | Number of visits |
| number | string | Card number |
| type_id | int | Loyalty card type identifier |
| salon_group_id | int | ID of the chain where the card was created |
| type | object | Object that contains the "id" and "title" fields: card type identifier and name |
| salon_group | object | Object that contains the "id" and "title" fields: identifier of the chain where the card type was created and the name of this chain |
| programs | array | Array with information about promotions linked to a loyalty card |
| rules | array | Array with information about the rules configured in the action |
The programs array consists of objects with the following fields:
| Attribute | Type | Description |
|---|---|---|
| id | int | Promotion ID |
| title | string | Action name |
| loyalty_type_id | int | Promotion type ID |
| item_type_id | int | Is cashback accrued from products |
| value_unit_id | int | Bonus field — Discount % or Fixed amount |
| group_id | int | ID of the chain where the action was created |
| loyalty_type | object | Object with information about the action |
The rules array consists of objects with the following fields:
| Attribute | Type | Description |
|---|---|---|
| id | int | Rule ID |
| loyalty_program_id | int | Identifier of the promotion to which the rule is attached |
| loyalty_type_id | int | Promotion type ID |
| value | decimal | Value from which the rule will work |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{phone}/{chain_id}/{location_id}
- Productionhttps://api.alteg.io/api/v1/loyalty/cards/{phone}/{chain_id}/{location_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{phone}/{chain_id}/{location_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
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}
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."}
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": [ { … } ] }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/user/loyalty_cards/{chain_id}
- Productionhttps://api.alteg.io/api/v1/user/loyalty_cards/{chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'OK
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}
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."}
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": [ { … } ] }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/card_types/salon/{location_id}
- Productionhttps://api.alteg.io/api/v1/loyalty/card_types/salon/{location_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'Response
application/json
[ { "id": 10992, "title": "Cashback", "salon_group_id": 145071, "salon_group": { … } }, { "id": 8230, "title": "Referral program", "salon_group_id": 145071, "salon_group": { … } } ]