Skip to content
/
Notify Altegio of Success...

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

Redirect URL after user registration with the partner service

Request

After completing registration, the user must be redirected to this URL in the browser, along with any required data needed by the partner service.

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
api_keynumber

API-key for messaging module.

Example: "2f181e2a-5c22-4ae7-9d9b-07104f312c28"
webhook_urlsArray of strings

Webhooks array

Example: ["https://example.com/webhook"]
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace/partner/callback/redirect \
  -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,
    "api_key": "2f181e2a-5c22-4ae7-9d9b-07104f312c28",
    "webhook_urls": [
      "https://example.com/webhook"
    ]
  }'

Responses

Accepted

Bodyapplication/json
successboolean
Example: true
Response
application/json
{
  "success": true
}

Notify Altegio of Successful Payment

Request

A webhook notification must be sent to this address to inform Altegio of a successful payment made on the partner service’s side.

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
currency_isostringrequired

Currency ISO (e.g.: USD, EUR, BYN)

Example: "EUR"
application_idnumberrequired

Application ID.

Example: 123
payment_sumnumberrequired

Payment amount.

Example: 990.99
payment_datestringrequired

Date and time of payment.

Example: "2022-01-01 10:10:00"
period_fromstringrequired

Date from which the paid period begins (inclusive).

Example: "2022-01-01 10:10:00"
period_tostringrequired

Date from which the paid period ends (inclusive).

Example: "2022-02-01 10:10:00"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace/partner/payment \
  -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,
    "currency_iso": "EUR",
    "payment_sum": 990.99,
    "payment_date": "2022-01-01 10:10:00",
    "period_from": "2022-01-01 10:10:00",
    "period_to": "2022-02-01 10:10:00"
  }'

Responses

Webhook ok

Bodyapplication/json
successboolean(Status.)

Status.

Example: true
dataobject

Data.

Response
application/json
{
  "success": true,
  "data": {
    "id": 123
  }
}

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

Webhooks

Event subscription and webhook configuration.

Operations

VoIP Integration

Telephony integration endpoints.

Operations

Dictionaries

Reference data (countries, cities, business types).

Operations