Перейти к содержанию

Индикаторы проекта

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/health/indicator/12345/run-script?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/health/indicator/12345/run-script?key=1234567890qwerty&project=12345
    

Запустить любой из процессов на странице Состояние проекта

POST /project/health/indicator/{indicatorId}/run-script

В разделе Состояние проекта отображаются основные процессы проекта, некоторые из которых можно запускать самостоятельно с помощью кнопки Запустить.

С помощью данного метода API вы можете запускать любой из процессов на этой странице, даже те, для которых в интерфейсе нет кнопки запуска.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/health/indicator/12345/run-script?project=12345

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

Без параметров.

{
    "execution_status": "success",
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

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

Без параметров.

Параметр Тип Описание Обязательный
execution_status string статус запуска: - success - запущен; - error - ошибка запуска. нет
status string нет