WeixinAPI PHP

Веб-компоненты для активного вызова интерфейсов корпоративного WeChat на PHP

Большая часть часто используемых функций уже реализована.

Документация по WeixinAPI-PHP

1. Для использования API WeChat необходимо сначала импортировать файл Api.class.php. Этот файл представляет собой основной класс пакета, все взаимодействия с API WeChat осуществляются через него. Основной класс автоматически создает access token и обеспечивает автоматическую загрузку. При внедрении этого файла в вашу систему, вам может потребоваться самостоятельно настроить механизм автоматической загрузки.

2. Каталог API содержит классы, выполняющие реальные операции с API WeChat. Название каждого класса соответствует модулю API корпоративного WeChat (через конструктор базового класса), конкретные узлы API задаются методами внутри каждого класса.

Например, класс UserApi.class.php соответствует следующему интерфейсу:

https://qyapi.weixin.qq.com/cgi-bin/user/

Метод add внутри класса UserApi.class.php обращается к узлу create, поэтому полный адрес запроса будет таким:

https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=ACCESS_TOKEN

Текущий список API:

• BaseApi.class.php: Базовый класс
• UserApi.class.php: Управление пользователями
• DepartmentApi.class.php: Управление отделами
• TagApi.class.php: Управление метками
• AgentApi.class.php: Управление приложениями
• JSSDKApi.class.php: Получение подписей JSSDK
• MediaApi.class.php: Управление медиафайлами
• MessageApi.class.php: Управление сообщениями ### 3. Cache каталог используется для кэширования AccessToken и js_ticket (когда кэш-драйвер установлен на File)

4. CacheDriver каталог служит кэш-драйвером, где Redis драйвер следует настроить перед использованием, лучше всего использовать конфигурацию, предоставляемую фреймворком

Расширение методов WeixinAPI-PHP

Для расширения достаточно создать новый файл в папке API, но имя нового класса должно соответствовать правилам разработки данного интерфейса, то есть названию в формате Модуль_интерфейса_WeChat + Api.class.php и наследованию от класса BaseApi. Например, UserApi.class.php. Здесь User представляет модуль WeChat API, а конкретные узлы модулей интерфейсов можно найти в других файлах Api.

Как использовать:

use WeixinAPI\Api;
// Подключение основного класса
include '/WeixinAPI/Api.class.php';
$CORP_ID      = '';     // ID корпорации CORP_ID
$CORP_SECRET  = '';     // Секретный ключ корпорации CORP_SECRET
$cacheDriver  = 'File'; // Кэш-метод, доступны два варианта: Redis и File
// Инициализация
Api::init($CORP_ID, $CORP_SECRET, $cacheDriver);
// Получение соответствующего модуля интерфейса с помощью фабричного метода
$api = Api::factory('Xxxx');
// Конкретные методы можно найти в комментариях внутри класса
$api->xxxx();
// Вывод результата
$res = var_dump($res);
```  Обратите внимание: вышеуказанный код содержит ошибку в написании переменной `$CORP_SECRET`. Верное название переменной — `$CORP_SECRET`.

```markdown
## При неудаче
```php
if (false === $res) {
  // Можно использовать оба варианта для получения сообщений об ошибках
  var_dump(Api::getError());
  var_dump($api->getError());
}

Операция с использованием метода Message интерфейса немного отличается и использует цепочку вызовов

Пример использования:

$Message->touser()->toparty()->totag()->file()/image()/text()/news/()->issafe()->send($agentid);

Где touser, toparty и totag должны быть обязательно вызваны хотя бы один раз. Аргументы этих методов могут быть либо одиночным ID пользователя/группы/тэга в виде строки, либо массивом нескольких ID.

Методы конкретных типов данных (file, image, text, news) можно вызвать только один раз за цепочку, повторные вызовы будут перезаписывать предыдущие значения.

issafe указывает, является ли сообщение безопасным.

send — это конечный метод отправки, его аргументом является agentid WeChat.

Порядок вызова методов до send может быть произвольным.

Контактный email: mhmrcui@126.com