Перейти к основному содержимому

Подтверждение доступа API 1.7.0

Методы API для работы с разделом «Подтверждение доступа».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
POST/access_confirmation

POST /access_confirmation​

Раздел: Подтверждение доступа.

Присылает ответ на запрос о подтверждении прохода. Запрос - событие по SSE с типом access-confirmation

Источник в Teamly

Назначение

URL запроса

Присылает ответ на запрос о подтверждении прохода. Запрос - событие по SSE с типом access-confirmation

https://{IP_контроллера}/api/v1/access_confirmation

Параметры запроса:

Название

Тип

Описание

confirmation*

object(body)

Тело запроса

BODY

Название

* - обязательный

Тип

Формат

Назначение

request_uuid*

string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

UUID запроса

resolution*

string

[ ALLOWED, FORBIDDEN ]

Резолюция

Пример:

URL запроса: POST
https://{IP_контроллера}/api/v1/

Body

{
  "request_uuid": "9bc61320-be98-11ee-8f50-cf4fc1bd5dc6",
  "resolution": "ALLOWED"
}

Варианты ответа:

Code 201 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI
{
  "description": "Send access confirmation",
  "requestBody": {
    "description": "Access confirmation result",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "request_uuid",
            "resolution"
          ],
          "properties": {
            "request_uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "resolution": {
              "type": "string",
              "enum": [
                "ALLOWED",
                "FORBIDDEN"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successfully counsumed access confirmation"
    },
    "400": {
      "description": "Bad request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/access_confirmation" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "request_uuid": "string",
  "resolution": "ALLOWED"
}'

Пример тела запроса​

{
  "request_uuid": "string",
  "resolution": "ALLOWED"
}