Провайдер учетных данных Берлоги (0.4)

Download OpenAPI specification:

Провайдер учетных данных для мобильных игр Берлоги. Предназначен для использования как мобильными приложениями, так и другими сервисами Берлоги. Для определения какому потребителю предназначена операция, нужно обратить внимание на её тэги.

Changelog

0.4

Для TalentOAuthConnect добавлен опциональный параметр redirect_uri.

0.3

Для TalentUserPlayers добавлена поддержка TalentOAuth.

application

Операции, предназначенные для приложений

Список приложений

Список приложений.

По-умолчанию сортируется по дате создания от новых к старым (order_by=created_at_desc) и включает в себя только опубликованные приложения (is_public=true).

query Parameters
offset
integer <int32>
Default: 0
limit
integer <int32> <= 50
Default: 20
is_public
string
Default: "true"
Enum: "true" "false" "all"

Фильтрация по публичности приложений.

  • true - только опубликованные
  • false - только не опубликованные
  • all - все
order_by
string
Enum: "created_at_asc" "created_at_desc" "updated_at_asc" "updated_at_desc"

Порядок сортировки результатов.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Запрос аутентификационного токена

Запрос аутентфикационного токена игрока.

Токен имеет ограниченное непродолжительное время жизни.

header Parameters
X-Forwarded-For
required
string
Request Body schema: application/json
required
application_id
required
string <uuid> (ApplicationID)

Идентификатор приложения.

player_id
required
string <uuid> (PlayerID)

Идентификатор игрока.

player_secret
required
string (PlayerSecret)

Секретный ключ игрока.

Responses

Request samples

Content type
application/json
{
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
  • "player_secret": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "expires_in": 0
}

Чтение информации об игроке

Чтение информации об игроке.

По-умолчанию ответ не содержит каких-либо данных. Для того чтобы добавить в ответ какие-то из параметров игрока, нужно указать их соотвествующими параметрами запроса get_*.

Authorizations:
BerlogaJWTServiceKey
path Parameters
player_id
required
string <uuid> (PlayerID)

PlayerID игрока

query Parameters
get_talent_id
boolean
Default: false

Включить в ответ talent_id

get_player_ids
boolean
Default: false

Включить в ответ player_ids

Responses

Response samples

Content type
application/json
{
  • "talent_id": 0,
  • "player_ids": [
    ]
}

Регистрация нового игрока

Регистрация нового PlayerID.

header Parameters
X-Forwarded-For
required
string
Request Body schema: application/json
required
application_id
required
string <uuid> (ApplicationID)

Идентификатор приложения.

device_id
required
string

DeviceID

Responses

Request samples

Content type
application/json
{
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "device_id": "string"
}

Response samples

Content type
application/json
{
  • "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
  • "player_secret": "string"
}

Миграция legacy PlayerID

Миграция имеющихся данных о PlayerID под актуальное API сервисов Берлоги.

В ответе возвращается PlayerSecret, который обязательно нужно сохранить на клиенте. Без него не получится пройти авторизацию клиентского API и они станут не доступны для этого PlayerID.

Request Body schema: application/json
required
application_id
required
string <uuid> (ApplicationID)

Идентификатор приложения.

player_id
required
string <uuid> (PlayerID)

Идентификатор игрока.

Responses

Request samples

Content type
application/json
{
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d"
}

Response samples

Content type
application/json
{
  • "player_secret": "string"
}

Перенаправление на авторизацию

Перенаправление на клиентский эндпонит OAuth авторизации Берлоги в Таланте.

Authorizations:
BerlogaJWT
query Parameters
redirect_uri
string

URI перенаправления пользователя после авторизации Берлоги в Таланте.

Responses

Response samples

Content type
application/json
{
  • "error_message": "string",
  • "verbose_message": "string"
}

Отсоединение учетной записи Таланта

Если у игрока и так (уже) нет авторизованной учетной записи Таланта, то метод вернет 204 ответ так же как при успешном отсоединении оной.

Authorizations:
BerlogaJWT

Responses

Response samples

Content type
application/json
{
  • "error_message": "string",
  • "verbose_message": "string"
}

Завершение авторизации в Таланте

Эндпоинт завершения авторизации Берлоги и перенаправление в приложение.

query Parameters
code
required
string
state
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error_message": "string",
  • "verbose_message": "string"
}

service

Операции, предназначенные для сервисов

Чтение информации об игроке

Чтение информации об игроке.

По-умолчанию ответ не содержит каких-либо данных. Для того чтобы добавить в ответ какие-то из параметров игрока, нужно указать их соотвествующими параметрами запроса get_*.

Authorizations:
BerlogaJWTServiceKey
path Parameters
player_id
required
string <uuid> (PlayerID)

PlayerID игрока

query Parameters
get_talent_id
boolean
Default: false

Включить в ответ talent_id

get_player_ids
boolean
Default: false

Включить в ответ player_ids

Responses

Response samples

Content type
application/json
{
  • "talent_id": 0,
  • "player_ids": [
    ]
}

Список PlayerID пользователя Таланта

Authorizations:
ServiceKeyTalentOAuth
path Parameters
talent_id
required
integer <int32>

ID пользователя Таланта

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

TalentOAuth токен пользователя

Authorizations:
ServiceKey
path Parameters
talent_id
required
integer <int32>

ID пользователя Таланта

Responses

Response samples

Content type
application/json
"string"

web

Операции, предназначенные для сайтов

Список приложений

Список приложений.

По-умолчанию сортируется по дате создания от новых к старым (order_by=created_at_desc) и включает в себя только опубликованные приложения (is_public=true).

query Parameters
offset
integer <int32>
Default: 0
limit
integer <int32> <= 50
Default: 20
is_public
string
Default: "true"
Enum: "true" "false" "all"

Фильтрация по публичности приложений.

  • true - только опубликованные
  • false - только не опубликованные
  • all - все
order_by
string
Enum: "created_at_asc" "created_at_desc" "updated_at_asc" "updated_at_desc"

Порядок сортировки результатов.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Авторизация существующим токеном

Authorizations:
BerlogaJWT
header Parameters
X-Token
required
string

TalentOAuth access_token

Responses

Response samples

Content type
application/json
{
  • "error_message": "string",
  • "verbose_message": "string"
}