Skip to content

Online Booking (1.0.0)

Public API for client-facing online booking integration. This API enables third-party developers to embed online booking functionality into external platforms such as business catalogs, branded apps, and partner services. Base URL: https://api.alteg.io/api

Authentication

All requests require partner authorization via Bearer token in the HTTP header: Authorization: Bearer <partner_token> To obtain a partner token, register in the Altegio Marketplace.

Rate Limits

  • 200 requests per minute per IP address - 5 requests per second per IP address
Download OpenAPI description
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/public/openapi/
Production server
https://api.alteg.io/api/v1/

Authentication

User authentication and verification endpoints for online booking

Operations

Online Booking

Endpoints for booking form, services, staff, availability, and appointment management

Operations

Client Personal Cabinet

Client account management and booking history

Operations

Update Online Booking User Data

Request

Updating a team member’s data in online booking.

When updating a phone number, the confirmation_code field must be included in the request. This code should be obtained using the SMS confirmation code of the phone number to change data

Security
BearerPartner
Headers
Acceptstringrequired

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

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
namestring

Name

Example: "James Smith"
emailstring

mail

Example: "j.smith@example.com"
phonestring

Phone number

Example: "+13155550175"
confirmation_codestring

SMS confirmation code (when changing phone number)

Example: "1234"
curl -i -X PUT \
  https://developer.alteg.io/_mock/en/public/openapi/booking/user \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "James Smith",
    "email": "j.smith@example.com",
    "phone": "+13155550175",
    "confirmation_code": "1234"
  }'

Responses

Accepted

Bodyapplication/json
Response
application/json
{ "success": true, "meta": { "message": "Accepted" } }

Get Online Booking User Data

Request

Retrieve online booking user data.

Security
BearerPartner
Headers
Acceptstringrequired

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

Example: 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/public/openapi/booking/user/data \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
0string

User Token

Example: "152afb01134237bc844d7e"
idinteger(int32)

User ID

Example: 32132133
user_tokenstring

User Token

Example: "152afb01134237bc844d7e"
namestring

Username

Example: "James Smith"
phonestring

User phone

Example: "+13155550175"
loginstring

User login

Example: "j.smith"
emailstring

User mail

Example: "j.smith@example.com"
avatarstring

User avatar

Example: "https://api.alteg.io/images/avatar.png"
Response
application/json
{ "0": "152afb01134237bc844d7e", "id": 32132133, "user_token": "152afb01134237bc844d7e", "name": "James", "phone": "+13155550175", "login": "j.smith", "email": "j.smith@example.com", "avatar": "https://api.alteg.io/images/avatar.png" }

Update Online Booking User Password

Request

Updating the password of an online booking user.

The response comes with a new user token.

Security
BearerPartner
Headers
Acceptstringrequired

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

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
old_passwordstring

Current Password

Example: "qwerty123"
new_passwordstring

New password

Example: "example!"
curl -i -X PUT \
  https://developer.alteg.io/_mock/en/public/openapi/booking/user/password \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "old_password": "qwerty123",
    "new_password": "example!"
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"user_token":"4de9d8cc108c0"}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{ "success": true, "data": { "user_token": "4de9d8cc108c0" }, "meta": [] }