Проверка доступности

Это запрос выполняется перед созданием домофона определенного вендора, чтобы убедиться в правильности введённых данных.

JSON

{
    "vendor": "iscom_x1",
    "schema": "http",
    "ip": "192.168.18.207",
    "port": "8080",
    "login": "root",
    "password": "123456"
}

POST /api/admin/v1/intercoms/check-available

Параметры метода

string vendor, Вендор

string schema, Схема, по которой будет осуществлено подключение

string ip, IP-адрес

integer port, Порт

string login, Логин пользователя

string password, Пароль пользователя

200 OK

Успешный ответ - статус 200 с пустым body

401 Unauthorized

Токен авторизации не передан или не валидный

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. VMS Admin/Общая информация панели администратора/Валидация администратора

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/check-available' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "vendor": "string",
    "schema": "string",
    "ip": "string",
    "port": "integer",
    "login": "string",
    "password": "string"
}'

PHP

$data = array (
  'vendor' => 'string',
  'schema' => 'string',
  'ip' => 'string',
  'port' => 'integer',
  'login' => 'string',
  'password' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/intercoms/check-available', false, $context);