API docs by Redocly

Scap.Service (1.0)

Download OpenAPI specification:

RouterApi

Запрос на добавление маршрутизатора.

Authorizations:
Bearer
Request Body schema:
required
Array
name
required
string non-empty

Имя маршрутизатора.

id
required
string non-empty

Уникальный идентификатор маршрутизатора.

url
string or null

Адрес сервиса. Если адрес и порт не указаны используется https://api-maps.axelot.ru.

port
integer or null <int32>

Номер порта. Если адрес и порт не указаны используется https://api-maps.axelot.ru.

apiKey
string or null

Ключ маршрутизатора.

enableRequestLogs
boolean

Признак логирования исходящих запросов к маршрутизатору.

enableResponseLogs
boolean

Признак логирования ответов маршрутизатора.

routeDurationValidity
required
integer <int32>

Количество дней, в течении которых хранятся полученные от маршрутизатора данные.

externalKey
string or null

Внешний ключ маршрутизатора для прокси. Если указан внешний ключ к запросам добавляется параметр '&apikey=ExternalKey'

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Запрос на получение списка зарегистрированных маршрутизаторов.

Authorizations:
Bearer
header Parameters
filterId
string

Фильтр. Идентификатор маршрутизатора.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Запрос на удаление маршрутизатора.

Authorizations:
Bearer
header Parameters
apiKey
required
string

Ключ маршрутизатора

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Запрос на очистку кэша маршрутизатора.

Authorizations:
Bearer
header Parameters
apiKey
string

Ключ маршрутизатора

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Запрос на добавление идентификатора бизнес системы (BsId).

Authorizations:
Bearer
header Parameters
systemId
required
string

Идентификатор бизнес системы (BsId)

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Запрос на получение идентификатора бизнес системы (BsId).

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "bsId": "string",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

Запрос на добавление адреса прямого доступа к маршрутизатору.

Authorizations:
Bearer
header Parameters
address
required
string

Адрес прямого доступа к маршрутизатору

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Запрос на получение зарегистрированного адреса прямого доступа к маршрутизатору.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

Запрос на удаление зарегистрированного адреса прямого доступа к маршрутизатору.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}