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

Групповая авторизация API 1.7.0

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

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

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

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

МетодПуть
GET/group_auth/get_secret_key
POST/group_auth/set_cookie

GET /group_auth/get_secret_key​

Раздел: Групповая авторизация.

Получение секретного ключа групповой авторизации

Источник в Teamly

Назначение

URL запроса

Получение секретного ключа групповой авторизации

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

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

Отсутствуют

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

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

Пример:

{
  "success": true,
  "secret_key": "string"
}

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

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

Параметры и ответы по OpenAPI
{
  "description": "Получение секретного ключа групповой авторизации",
  "responses": {
    "200": {
      "description": "Секретный ключ успешно получен",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success",
              "secret_key"
            ],
            "properties": {
              "success": {
                "type": "boolean"
              },
              "secret_key": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Пользователь не найден",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Ошибка сервера",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

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

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

curl -k -X GET "https://{IP_контроллера}/api/v1/group_auth/get_secret_key" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "success": true,
  "secret_key": "string"
}

POST /group_auth/set_cookie​

Раздел: Групповая авторизация.

Установка cookie групповой авторизации

Источник в Teamly

Назначение

URL запроса

Установка cookie групповой авторизации

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

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

Название

Тип

Описание

group_auth_set*

object(body)

Тело запроса

BODY

Название

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

Тип

Формат

Назначение

login*

string

Логин

secret_key*

string

Секретный ключ групповой авторизации

Пример:

URL запроса: POST
https://123.45.234.205/api/v1/group_auth/set_cookie

Body

{
  "login": "rtyu12345ko",
  "secret_key": "Wer34!@Vb78"
}

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

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

{
  "success": true,
  "message": "Cookie был успешно установлен"
}

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

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

Параметры и ответы по OpenAPI
{
  "description": "Установка cookie групповой авторизации",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "login",
            "secret_key"
          ],
          "properties": {
            "login": {
              "type": "string"
            },
            "secret_key": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Token has been successfully set",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success",
              "message"
            ],
            "properties": {
              "success": {
                "type": "boolean"
              },
              "message": {
                "type": "string"
              }
            }
          },
          "example": {
            "success": true,
            "message": "Cookie был успешно установлен"
          }
        }
      }
    },
    "400": {
      "description": "Пользователь не найден",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Ошибка сервера",
      "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/group_auth/set_cookie" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "login": "string",
  "secret_key": "string"
}'

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

{
  "login": "string",
  "secret_key": "string"
}

Пример ответа​

{
  "success": true,
  "message": "Cookie был успешно установлен"
}