Skip to content
/
Notify Altegio of Availab...

Developer Tools (1.0.0)

APIs for partners building integrations with the Altegio platform. Base URL: https://api.alteg.io/api

Available Methods

Marketplace — Manage your marketplace applications: list connected locations, configure tariffs, handle billing, process installation/uninstallation callbacks. Webhooks — Configure event notifications for your integrations. Receive real-time updates when appointments, clients, or other entities change. VoIP Integration — Connect telephony systems to match incoming calls with client records and log call history. Dictionaries — Reference data for building forms and validations: countries, cities, business types.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/developers/openapi/
Production
https://api.alteg.io/api/v1/

Marketplace

Marketplace application management, billing, and installation.

Operations

Chargeback Notice

Request

Chargeback Notice

Security
BearerPartner
Path
payment_idnumberrequired

Payment ID.

Example: 123
Headers
Acceptstringrequired

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

Example: application/vnd.api.v2+json
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace/partner/payment/refund/123 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>'

Responses

Refund confirmed

Response
No content

Notify Altegio of Available SMS Sender Names

Request

This endpoint is used to send the list of SMS sender names available to the user. The user will be able to choose from any of the provided sender names.

Security
BearerPartner
Headers
Acceptstringrequired

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

Example: application/vnd.api.v2+json
Bodyapplication/json
salon_idnumberrequired

Location ID.

Example: 123
application_idnumberrequired

Application ID

Example: 123
short_namesArray of stringsrequired

Array of SMS names

Example: ["Altegio","AL"]
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace/partner/short_names \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salon_id": 123,
    "application_id": 123,
    "short_names": [
      "Altegio",
      "AL"
    ]
  }'

Responses

OK

Response
No content

Webhook from Altegio About Application Events

Request

Note: This is not a callable endpoint.

This section describes how Altegio sends webhook notifications when specific events occur in the application-to-location lifecycle. The following event types are currently supported:

  • uninstall — Sent when the application is disabled on the Altegio side.
  • freeze — Sent when the integration is frozen due to service expiration.

You can configure the webhook URL for receiving these events in your Altegio Developer Account.

Headers
Acceptstringrequired

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

Example: application/vnd.api.v2+json
Bodyapplication/json
salon_idnumberrequired

Location ID.

Example: 123
application_idnumberrequired

Application ID.

Example: 123
eventstringrequired

Event Slug.

Enum"uninstall""freeze"
Example: "uninstall"
partner_tokenstringrequired

Bearer token of the developer's location (to verify the origin of the webhook)

Example: "yasdfkjah2328aj"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace_webhook \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Content-Type: application/json' \
  -d '{
    "salon_id": 123,
    "application_id": 123,
    "event": "uninstall",
    "partner_token": "yasdfkjah2328aj"
  }'

Responses

From the side of the partner, a response code of successful processing (200-299) is expected.

Response
No content

Webhooks

Event subscription and webhook configuration.

Operations

VoIP Integration

Telephony integration endpoints.

Operations

Dictionaries

Reference data (countries, cities, business types).

Operations