API / Публичные API регистрации и аутентификация внешней системы

Публичные API регистрации и аутентификация внешней системы

Запрос на регистрацию внешней системы

Метод запроса

POST

Протокол

HTTP

Запрос

http://example.com:48080/v1/orchestra/system/registration

Тело запроса:

{
    "uuid":"5d5ec66f-357d-4c2d-bbc1-2012278d2361",
    "name":"Название системы",
    "desc":"Описание системы"
}

Параметр

Описание

uuid

Идентификатор внешней системы (генерируется внешней системой), далее в запросах может иметь аббревиатуру auth_tkn

name

Название (будет отображаться в консоли администрирования)

desc

Описание (будет отображаться в консоли администрирования)

Пример ответа сервера:

{
    "status": 200
}

Параметр

Описание

status

Числовой код результата выполнения запроса (используются коды состояния HTTP)

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

Метод запроса

POST

Протокол

HTTP

Запрос

http://example.com:48080/v1/orchestra/system/status

Тело запроса:

{
    "uuid":"5d5ec66f-357d-4c2d-bbc1-2012278d2361"
}

Параметр

Описание

uuid

Идентификатор внешней системы

Пример ответа сервера:

{
    "status": 200
}

Параметр

Описание

status

Числовой код результата выполнения запроса (используются коды состояния HTTP)