Skip to content
/
Application Status Data f...

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

Update notification channel availability

Request

Updates available notification channels for the application.

Note: Only for Chat Bots and SMS Aggregators category applications. For marketplace partners only.

Security
BearerPartner
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}

Bodyapplication/jsonrequired
salon_idintegerrequired

Location ID

Example: 123
application_idintegerrequired

Application ID

Example: 456
channel_slugstringrequired

Channel to update availability for

Enum"sms""whatsapp"
Example: "sms"
is_availablebooleanrequired

Channel availability flag

Example: true
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace/application/update_channel \
  -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": 456,
    "channel_slug": "sms",
    "is_available": true
  }'

Responses

Channel availability updated successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Response
application/json
{
  "success": true,
  "data": {},
  "meta": []
}

Application Status Data for Any Location

Request

This endpoint is used to retrieve information about the application's installation status in a specific location.

Security
BearerPartner
Path
location_idnumberrequired

Location ID

application_idnumberrequired

Application ID

Headers
Acceptstringrequired

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

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

Responses

Info about application location link

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

Example: true
dataobject
Example: {"logs":[{"changed_at":"2022-06-27 12:20:02","status_from":"uninstalled","status_to":"pending","source":"marketplace"},{"changed_at":"2022-06-27 12:22:02","status_from":"pending","status_to":"active","source":"partner_api"}],"payments":[{"id":1523,"payment_sum":1523.12,"payment_date":"2022-06-27 12:22:02","is_refunded":false,"period_from":"2022-06-27 00:00:00","period_to":"2022-07-27 00:00:00"}],"connection_status":{"status":"active","created_at":"2022-06-27 12:20:02"}}
metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": {
    "logs": [ … ],
    "payments": [ … ],
    "connection_status": { … }
  }
}

Application Uninstall

Request

This endpoint is used by the partner service to uninstall the application from a specific location.

Security
BearerPartner
Path
location_idnumberrequired

Location ID

application_idnumberrequired

Application ID

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/salon/{location_id}/application/{application_id}/uninstall' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>'

Responses

successfully uninstalled

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject or null(response_data_null_object)

Response data.

metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": null,
  "meta": {}
}

Webhooks

Event subscription and webhook configuration.

Operations

VoIP Integration

Telephony integration endpoints.

Operations

Dictionaries

Reference data (countries, cities, business types).

Operations