Перейти к основному содержимому

Evolutrix CRM Rest API | Master System (1.0.0)

Download OpenAPI specification:Download

Описание Rest API — методов для взаимодействия с серверной стороной админки.

Модули

enable

Подключить модуль.

Authorizations:
BearerToken
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

disable

Отключить модуль.

Authorizations:
BearerToken
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Статус лицензии

license

Устанавливает статус лицензии из МС

Authorizations:
BearerToken
Request Body schema: application/json

Статус лицензии

license
string

Статус лицензии.
Обязателен

Responses

Request samples

Content type
application/json
{
  • "license": "suspended"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

Платежи (Master System)

updatePayment

Обновить статус платежа и отправить событие в WebSocket канал.

Authorizations:
BearerToken
Request Body schema: application/json

Данные для обновления статуса платежа

payment_id
required
string

Идентификатор платежа

status
required
string

Статус платежа

Responses

Request samples

Content type
application/json
{
  • "payment_id": "pay_1234567890",
  • "status": "succeeded"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Информация для расчёта тарифа

tariff-info

Информация для расчёта тарифа

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Системное сообщение

system_message

Принимает сообщения из МС

Authorizations:
BearerToken
Request Body schema: application/json

Системное сообщение

message
required
string

Сообщение

type
required
string

Тип

admin_only
required
boolean

Только админу

Responses

Request samples

Content type
application/json
{
  • "message": "system message",
  • "type": "alarm",
  • "admin_only": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}