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

Authorize Online Booking User

Request

When a user of an online account changes their password, their API key will change and a new authorization will be required

AttributeTypeDescription
loginstringThe visitor's phone number in the format +13155550175, or their email address.
passwordstringVisitor password
Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token

Bodyapplication/jsonrequired
loginstringrequired

Phone number or Email

Example: "testuser@alteg.io"
passwordstringrequired

Password

Example: "testpass"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/public/openapi/booking/auth \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "login": "testuser@alteg.io",
    "password": "testpass"
  }'

Responses

Created

Bodyapplication/json
idinteger(int32)

User ID

Example: 123456
user_tokenstring

User_token of the user

Example: "wec23fh8cDfFV4432fc352456"
namestring

Username

Example: "James Smith"
phonestring

User phone

Example: "+13155550175"
loginstring

User login

Example: "j.smith"
emailstring

User mailing address

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

Path to the user's avatar file

Example: "https://assets.alteg.io/general/0/01/123456789098765_12345678909876.png"
Response
application/json
{ "id": 123456, "user_token": "wec23fh8cDfFV4432fc352456", "name": "James Smith", "phone": "+13155550175", "login": "j.smith", "email": "j.smith@example.com", "avatar": "https://assets.alteg.io/general/0/01/123456789098765_12345678909876.png" }

Online Booking

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

Operations

Client Personal Cabinet

Client account management and booking history

Operations