User authentication and session management for B2B integrations
- Receipt PDF for the visit
Get list of appointments
Create a New Appointment
Get an Appointment
Edit Appointment
Delete Appointment
Get a List of Partner Appointments
Get a visit
Get Visit Details
Edit Visit
Get comments
Leave a Comment
Create Recurring Appointments
Update Recurring Appointments
Delete Recurring Appointments
Receipt PDF for the visit
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/
Body*/*required
Visit status (2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user is waiting, -1 - the user did not show)
Example: 1
Array of objects of new commodity transactions
Example: [{"id":12345,"amount":100,"account_id":23322}]
Array of commodity transactions objects
Example: [{"id":2168657,"title":"Vital Creme Shampoo Plus","barcode":"123","article":"120277","amount":-1,"cost_per_unit":15,"price":15,"cost":12,"operation_unit_type":2,"master_id":55436,"storage_id":91303,"good_id":232658,"discount":20}]
Array of objects with services
Example: [{"id":389045,"title":"Hand massage (10 min)","cost":255,"cost_per_unit":300,"discount":15,"first_cost":300,"record_id":10403702}]
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/visits/{visit_id}/{record_id}
- Productionhttps://api.alteg.io/api/v1/visits/{visit_id}/{record_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://developer.alteg.io/_mock/en/b2b-v1/openapi/visits/12345/67890 \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: */*' \
-d '[object Object]'- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/attendance/receipt_print/{visit_id}
- Productionhttps://api.alteg.io/api/v1/attendance/receipt_print/{visit_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/attendance/receipt_print/12345 \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'Request
The comment object has the following fields:
| Field | Type | Description |
|---|---|---|
| id | number | Comment ID |
| salon_id | number | location ID |
| type | number | 1 - comment to the team member, 0 - to the location |
| master_id | number | Team Member ID if type = 1 |
| text | string | Comment text |
| date | string | Date when the comment was left |
| rating | number | Rating (from 1 to 5) |
| user_id | number | Id of the user who left the comment |
| username | string | Name of the user who left the comment |
| user_avatar | string | Avatar of the user who left the comment |
| record_id | number | ID of the post after which the review was left (the value will be non-zero if the review was left through a link asking for a review after the visit) |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/comments/{location_id}
- Productionhttps://api.alteg.io/api/v1/comments/{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/comments/{location_id}?start_date=string&end_date=string&team_member_id=0&rating=0&page=0&count=0' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'Response
application/json
{ "success": true, "data": [ { … } ], "meta": [] }