User authentication and session management for B2B integrations
- Get a List of Card Types Available at the Chain
Get a List of Customer Cards by ID
Get a List of Customer Cards by Phone Number
Get User Loyalty Cards
Get a list of card types available at the location
Get a List of Card Types Available for Issuance to the Client
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 a List of Card Types...
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 card types that are available for issuance to a location client.
| Attribute | Type | Description |
|---|---|---|
| id | int | Card type identifier |
| title | string | Card type name |
| salon_group_id | int | ID of the chain where the card type was created |
| salon_group | object | An 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
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/card_types/client/{location_id}/{phone}
- Productionhttps://api.alteg.io/api/v1/loyalty/card_types/client/{location_id}/{phone}
- 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/client/12345/13155550175 \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'Response
application/json
[ { "id": 10992, "title": "Cashback", "salon_group_id": 145071, "salon_group": { … } }, { "id": 8230, "title": "Referral program", "salon_group_id": 145071, "salon_group": { … } } ]
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/{chain_id}/loyalty/card_types
- Productionhttps://api.alteg.io/api/v1/chain/{chain_id}/loyalty/card_types
- 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/chain/{chain_id}/loyalty/card_types' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
-H 'Content-Type: string'Response
application/json
[ { "id": 123, "title": "Loyalty card type" } ]
Request
| Attribute | Type | Description | |----------------------|--------|----------------- ------------------------------| | loyalty_card_number | number | Loyalty card number | | loyalty_card_type_id | number | Loyalty card type identifier | | phone | number | Customer phone number (e.g., 13155550175 for +13155550175) |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{location_id}
- Productionhttps://api.alteg.io/api/v1/loyalty/cards/{location_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{location_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"loyalty_card_number": "9090909",
"loyalty_card_type_id": "8230",
"phone": 13155550175
}'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": 9250498, "balance": 0, "points": 0, "paid_amount": 16300, "sold_amount": 19320, "visits_count": 5, "number": 1010101, "type_id": 8230, "salon_group_id": 145071, "type": { "id": 8230, "title": "cashmesh", "salon_group_id": 145071 }, "salon_group": { "id": 145071, "title": "Dough chain1." }, "programs": [ { … } ] }