API и интеграции

Health check

5min
описание параметр health check token используется для активации эндпоинта /api/v1/app/health check , который проверяет состояние пассворка для доступа к эндпоинту требуется передать токен — стандартная авторизация не используется если токен не задан, эндпоинт считается отключённым активация в файле config env прописать следующий параметр с значением config env health check token=custom token конфигурационный файл config env расположен в следующих директориях (в зависимости от выбора установки пассворка) linux — /var/www/init/config env windows server — c \inetpub\wwwroot\passwork\init\config env docker — /\<passwork>/conf/keys/config env пример запроса linux curl request post \\ \ url "https //passwork example com/api/v1/app/health check" \\ \ header 'accept application/json' \\ \ header 'content type application/json' \\ \ data '{ "token" "custom token" }' windows server invoke restmethod uri "https //passwork example com/api/v1/app/health check" ` method post ` headers @{ "accept" = "application/json" "content type" = "application/json" } ` body '{ "token" "custom token" }' пример вывода linux { "states" { "mongodb" "ok" }, "errors" \[] } windows server states errors \ @{mongodb=ok} {} если полученный ответ от пассворка в формате linux { "format" "base64", "content" "eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119" } windows server format content \ base64 eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119 необходимо расшифровать значение content linux # команда echo "eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119" | base64 d \# вывод {"states" {"mongodb" "ok"},"errors" \[]} windows server # команда "eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119" | foreach object { \[system text encoding] utf8 getstring(\[system convert] frombase64string($ )) } \# вывод {"states" {"mongodb" "ok"},"errors" \[]}