Получение списка email-адресов пользователя
Beta
New

⚠️

Ограниченный доступ

Описание

Этот раздел документации описывает конечную точку для получения списка email-адресов, связанных с аккаунтом аутентифицированного пользователя. Возвращается информация о каждом email-адресе, включая его верификацию, является ли он основным и виден ли публично.

Общие замечания

Для версий API указывайте заголовок Accept с соответствующей версией:
```
Accept: application/vnd.gitverse+json;version=1
```
Базовый URL для всех конечных точек:
```
https://api.gitverse.ru
```
Все данные возвращаются в формате JSON.
Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением.

Скоупы

Для успешного выполнения этого запроса требуется один из следующих скоупов:

"read:public_api";
"public_api".

Конечная точка

GET /user/emails

Параметры пути

Нет обязательных параметров пути. Конечная точка /user/emails автоматически определяет текущего аутентифицированного пользователя на основе предоставленного токена.

Заголовки запроса

Content-Type: application/json — указывает, что тело ответа будет в формате JSON;
Accept: application/vnd.gitverse+json;version=1 — указывает версию API;
Authorization: Bearer {user_token} — требуется для аутентификации.

Тело запроса

Тело запроса не требуется. Этот метод работает без передачи данных в теле запроса.

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

[
    {
        "email": "dlborun@test.ru",
        "verified": true,
        "primary": false,
        "is_public": false
    },
    {
        "email": "new1@example.com",
        "verified": true,
        "primary": true,
        "is_public": true
    },
    {
        "email": "new2@example.com",
        "verified": true,
        "primary": false,
        "is_public": false
    },
    {
        "email": "new3@example.com",
        "verified": true,
        "primary": false,
        "is_public": false
    }
]

Поля ответа

Каждый элемент массива представляет собой объект email-адреса со следующими полями:

Поле	Тип	Описание
`email`	string	Email-адрес пользователя.
`verified`	boolean	Подтверждён ли адрес электронной почты.
`primary`	boolean	Является ли этот email основным.
`is_public`	boolean	Доступен ли email другим пользователям (публичный/приватный).

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

GET https://api.gitverse.ru/user/emails
Content-Type: application/json
Accept: application/vnd.gitverse+json;version=1
Authorization: Bearer YOUR_ACCESS_TOKEN

Обработка ошибок

Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением:

Пример ошибки

{
  "error": "Unauthorized",
  "message": "Authentication failed. Invalid or missing access token.",
  "status": 401
}

Возможные коды ошибок

400 Bad Request — некорректный запрос;
401 Unauthorized — необходима аутентификация. Отсутствует или неверен токен;
403 Forbidden — у пользователя нет прав для доступа к email-информации;
500 Internal Server Error — внутренняя ошибка сервера.

Следующие шаги

После получения email-адресов вы можете:

обновить информацию о профиле с помощью метода PATCH /user;
управление email-адресами может быть реализовано через отдельные эндпоинты (если доступны).

Если у вас возникнут вопросы или потребуется дополнительная информация, пожалуйста, обращайтесь в службу поддержки или свяжитесь с командой разработки.

Добавление новых email-адресов пользователя Удаление email-адресов пользователя

Получение списка email-адресов пользователяBetaNew