Геншин Карточки

Махиру предоставляет вам крутой API для генерации карточек, который вы можете использовать после подключения своей учетной записи HoYoLab. Это позволяет создавать прямые ссылки на ваши карточки, которые обновляются в режиме реального времени.

Структура URL-адреса

Базовый URL-адрес для API карточек:

https://mahiru.one/g/

Структура URL-адреса выглядит следующим образом:

https://mahiru.one/g/{userId}/{method}

userId – Идентификатор пользователя, чью карточку вы хотите получить. Вы можете узнать его тут.
method – Метод, который вы хотите использовать. См. таблицу ниже со списком всех доступных методов.

Методы

Каждый метод соответствует определенной команде. См. список всех команд, имеющих методы в API Геншин Карточек, ниже.

Некоторые методы требуют аутентификации. См. секцию Приватность и безопасность.

Метод	Команда	Структура URL-адреса	Требует аутентификацию
`profile`	`genshin_profile`	`https://mahiru.one/g/{userId}/profile`	Нет
`abyss`	`genshin_abyss`	`https://mahiru.one/g/{userId}/abyss`	Нет
`exploration`	`genshin_exploration`	`https://mahiru.one/g/{userId}/exploration`	Нет
`notes`	`genshin_notes`	`https://mahiru.one/g/{userId}/notes`	Да
`tcg`	`genshin_tcg`	`https://mahiru.one/g/{userId}/teapot`	Нет
`teapot`	`genshin_teapot`	`https://mahiru.one/g/{userId}/teapot`	Нет
`characters`	`genshin_characters`	`https://mahiru.one/g/{userId}/characters`	Нет
`character`	`genshin_characters`	`https://mahiru.one/g/{userId}/character/{characterId}`	Нет

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

Параметры запроса могут помочь вам настроить изображение, которое вы хотите получить.

Стандартные параметры

Стандартные параметры, которые присутствуют в каждом методе:

theme Литерал['light', 'dark'] (опционально) – Тема изображения. Может быть установлена на light (светлая) либо dark (тёмная).
language Литерал['ru', 'en'] (опционально) – Язык изображения. Может быть установлен на ru (Русский) либо en (Английский).
authkey строка (опционально) – Ваш ключ аутентификации. Необходим для методов, которые требую аутентификации и для тех, которым вы отключили опцию «Показывать другим» в Панели управления.

Уникальные параметры

Некоторые методы имеют уникальные параметры:

Метод	Параметры	Тип	Описание
`abyss`	`schedule`	`Литерал['current', 'previous'] (опционально)`	Период бездны. `current` (текущий) либо `previous` (предыдущий)

Добавление параметров

Чтобы добавить параметры, в конец URL-адреса, добавляется ?, за которым сразу следует параметр:

https://mahiru.one/g/{userId}/{method}?language=en&theme=dark

Приватность и безопасность

Предупреждение

Ни в коем случае не делитесь с кем-либо URL-адресами, содержащими ваш ключ аутентификации и не загружайте такие изображение, используя их URL-адреса. Каждый, у кого есть ваш ключ авторизации, может получить непредвиденный доступ к вашим данным, которые хранит Махиру. Если вы случайно слили свой ключ авторизации, свяжитесь с нами в нашей Телеграм группе, чтобы сбросить его как можно скорее.

Вы можете ограничить другим пользователям доступ к вашим карточкам, отключив опцию «Показывать другим» для методов, которыми вы не хотите делится. (1)

Некоторые методы всегда требуют аутентификации. Это те, которыми вы, скорее всего, не захотите делиться, например, заметки (notes). См. методы, которые всегда требуют аутентификации в таблице методов.

Для аутентификации запроса вам необходимо передать ключ аутентификации в URL-адресе:

https://mahiru.one/g/{userId}/{method}?authkey=ABCDEFG12345

Ограничения

Каждый метод имеет ограничение в 10 запросов/в минуту/на один IP. Если вы превысите данный лимит, скорость запросов для вас будет ограничена.

Кэширование

Для создания каждого изображения требуется значительный объем ресурсов сервера. Поэтому мы используем кэширование. Время кэширования каждого метода, кроме notes, составляет один час. Для метода notes это 3600 секунд (5 минут).