Skip to content
/
Application Uninstall

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

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": {}
}

Application Installation for a Location

Request

The integration settings of the partner service must be sent to this address. Once received, the application will be configured and installed for the corresponding location.

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 \
  -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

All parameters installed

Response
No content

Webhooks

Event subscription and webhook configuration.

Operations

VoIP Integration

Telephony integration endpoints.

Operations

Dictionaries

Reference data (countries, cities, business types).

Operations