SDK для 微信小程序

GitHub исходный код: https://github.com/authing/authing-wxapp-sdk.

Authing 小程序 SDK (authing-wxapp-sdk) подходит для использования в среде «微信» и основан на authing-js-sdk, адаптированном для этой среды. Вы можете использовать все методы AuthenticationClient из authing-js-sdk, такие как получение и изменение пользовательских данных, добавление пользовательских полей и т. д.

Кроме того, SDK предоставляет специальные методы для работы с «мини-программой»:

• получение номера телефона пользователя через авторизацию в WeChat;
• вход в систему с помощью авторизации в WeChat;
• вход с номером телефона, полученным через авторизацию в WeChat.

В Authing для настройки входа в мини-программе

Чтобы использовать Authing 小程序 SDK в мини-приложении, вам необходимо сначала зарегистрировать мини-приложение на платформе WeChat (https://mp.weixin.qq.com/) и настроить его в консоли Authing (https://console.authing.cn/console/userpool).

1. Зарегистрируйте аккаунт разработчика WeChat Mini Program. Если вам нужно получить номер телефона пользователя, вы должны пройти аутентификацию в WeChat. Добавьте core.authing.cn в список разрешённых доменов запроса WeChat:

   Рисунок 1.

2. В консоли Authing включите функцию входа через социальные сети для мини-программы.

   Получите AppId и AppSecret для мини-приложения:

   Рисунок 2.

3. Перейдите в консоль Authing, выберите «Подключение источника идентификации» — «Социальные сети» — «Вход в мини-программу»:

   Рисунок 3.

4. Введите AppId и AppSecret мини-приложения и нажмите «Сохранить».

Рисунок 4.

Установка

С версии 2.2.1 базовой библиотеки мини-программ и версии 1.02.1808300 инструмента разработчика и выше, мини-программа поддерживает установку сторонних пакетов через npm. Подробнее см.: Поддержка npm | Документация WeChat Open (https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html).

Установите пакет npm

Используйте npm:

npm install authing-wxapp-sdk

Используйте yarn:

yarn add authing-wxapp-sdk

Сборка npm в инструменте разработчика

Нажмите «Меню» в инструменте разработки: «Инструменты» → «Сборка npm»:

Рисунок 5.

Отметьте опцию «Использовать модули npm»:

Рисунок 6.

Инициализация

Для инициализации AuthenticationClient требуется передать AppId (идентификатор приложения):

Вы можете просмотреть список своих приложений в консоли.

const { AuthenticationClient } = require("authing-wxapp-sdk");

const authing = new AuthenticationClient({
  appId: "YOUR_APP_ID",
});

Полный список параметров:

• appId: идентификатор приложения Authing (обязательно);
• accessToken: инициализировать SDK с токеном пользователя (необязательно, вы можете сохранить токен пользователя в localStorage браузера для реализации функции запоминания входа);
• timeout: время ожидания запроса в миллисекундах, по умолчанию 10 000 (10 секунд);
• onError: функция обработки ошибок, которую можно использовать для глобального захвата всех исключений запросов Authing Client. Определение функции:

(code: number, message: string, data: any) => void

Полный список кодов ошибок см. в этом документе (https://docs.authing.cn/v2/reference/error-code.html).

• host: адрес сервера Authing. Если вы используете общедоступную облачную версию, этот параметр можно игнорировать. Если вы используете частную версию развёртывания, этот параметр обязателен. Формат: https://authing-api.mydomain.com, без / в конце.

После успешного входа пользователя SDK сохранит токен в хранилище WeChat, и последующие запросы будут автоматически включать токен.

Рисунок 7.

const { code } = await wx.login();
// Без необходимости авторизации пользователя
const user = await authing.loginByCode(code); // Успешный вход, токен сохраняется в хранилище WeChat

// После входа вы можете выполнить эту операцию
await authing.updateProfile((nickname: "Bob"));

Когда пользователь снова откроет мини-программу, если токен сохранён в хранилище WeChat мини-программы, запрос к authing будет автоматически содержать токен.

// Этот запрос может быть успешным, потому что пользователь вошёл в систему.
await authing.updateProfile((nickname: "Mick"));

Справочник API

Вы можете вызывать все методы AuthenticationClient в authing-js-sdk так же, как и в authing-js-sdk.

loginByCode

Войдите в систему, используя авторизацию WeChat.

Если пользователь впервые входит в мини-программу и не использовал один и тот же основной аккаунт для входа в мини-программу с тем же приложением WeChat, будет создан новый аккаунт.

Если это первый вход пользователя в мини-программу, но пользователь уже использовал одно и то же основное приложение WeChat для входа в связанную мини-программу, будет возвращён соответствующий аккаунт WeChat.

Параметры:

• code: код, полученный при вызове wx.login(), не требует авторизации пользователя. Обязательно.
• options: необязательно.
• iv: значение iv при нажатии кнопки компонента Button WeChat с open-type = getUserInfo. iv и encryptedData должны передаваться вместе, Authing Server попытается расшифровать данные пользователя из iv и encryptedData. Требуется авторизация пользователя при первом использовании. Необязательно.
• encryptedData: значение encryptedData при нажатии кнопки компонента Button WeChat с open-type = getUserInfo. iv и encryptedData должны передаваться вместе, Authing Server попытается расшифровать данные пользователя из iv и encryptedData. Требуется авторизация пользователя при первом использовании. Необязательно.
• rawData: значение rawData при нажатии кнопки компонента Button WeChat с open-type = getUserInfo.