Работа с инвайт кодами

Работа с инвайт кодами

Работа осуществляется через админ панель

Создание инвайта

Описание

Создание нового инвайт кода. Необходима авторизация + 2fa

Ручка

    POST /invite/v1/create_invite_token

Полный адрес в сети

Дев: https://gateway.devterra.ru/admin/invite/v1/create_invite_token
Прод: https://mobile-api.terraprod.ru/admin/invite/v1/create_invite_token

Тело запроса

Столбец	Тип	Описание	Обязательность
count	int	Кол-во токенов, которые будут сгенерированы	✅
entityID	int	Идентификатор сущности к которой будет привязан инвайт	✅
expirationTime	int	Кол-во минут, которое инвайт будет жить	❌
inviteTokens	[]string	На случай, если у вас уже заготовлены инвайты, можно передать сюда	❌
oneOff	bool	Сделать инвайт многоразовым или нет	✅
tokenAnotherRole	int	Пользовательская роль инвайта	✅
tokenLength	int	Длина токена при генерации	✅
tokenRole	int	Обозначение к какому сервису относится инвайт	✅

Важно

Необходимо учитывать, что если мы указываем count и inviteTokens одновременно, то у нас сгенерируется count + inviteTokens кол-во токенов

Доступные символы для инвайтов: abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ123456789

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

{
  "count": 10,
  "entityID": 21005,
  "expirationTime": 100,
  "inviteTokens": [
    "string"
  ],
  "oneOff": true,
  "tokenAnotherRole": 6,
  "tokenLength": 8,
  "tokenRole": 0
}

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

{
  "inviteTokens": [
    "string"
  ]
}

Изменение инвайта

Описание

Изменение полей инвайт кода. Необходима авторизация + 2fa. Изменяются только переданные поля, если не нужно менять поле, то отправляем null

Ручка

    POST /invite/v1/update_invite_token

Полный адрес в сети

Дев: https://gateway.devterra.ru/admin/invite/v1/update_invite_token
Прод: https://mobile-api.terraprod.ru/admin/invite/v1/update_invite_token

Тело запроса

Столбец	Тип	Описание	Обязательность
inviteToken	string	Изменяемый токен	✅
entityID	int	Идентификатор сущности к которой будет привязан инвайт	❌
expirationTime	int	Кол-во минут, которое инвайт будет жить	❌
oneOff	bool	Сделать инвайт многоразовым или нет	❌
tokenAnotherRole	int	Пользовательская роль инвайта	❌
tokenStatus	int	Статус инвайт кода	❌

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

{
  "inviteToken": "string",
  "entityID": 21005,
  "expirationTime": 10,
  "oneOff": true,
  "tokenAnotherRole": 4,
  "tokenStatus": 0
}