Перейти к содержанию

Партнёрам#

Для проверки методов партнёров, рекомендуем использовать коллекцию Postman для партнёров.

Партнёрская схема работы предполагает более глубокую интеграцию с сервисом и работу с большим числом инстансов на вашей стороне:

  • Управление инстансами как в личном кабинете, так и по API

  • Постоплатная система работы (со второго месяца работы)

  • Непрерывная работа инстансов даже при отрицательном балансе (в том числе создание новых инстансов)

  • Посуточная тарификация (за созданные и не удалённые инстансы)

  • Выделенная линия поддержки

По вопросам подключения к партнёрской схеме и дополнительных условиях просим вас писать на почту support@green-api.com или в чат на сайте.

Для определения типа Вашего личного кабинета перейдите во вкладку Профиль -> Информация о аккаунте -> Тип аккаунта -> Партнерский

Важно!

Списание оплаты за инстанс для партнёров происходит в 00:00 UTC+3:00.

Настройка API для партнёров:
1. Получение партнёрского ключа
2. Подготовка и работа с личным кабинетом партнёра
3. Оплата партнёрского инстанса
4. Тестирование методов
5. Формат запроса
6. Доступные методы API для партнёров
7. Порядок работы

Получение партнёрского ключа#

Получение партнёрского API-ключа происходит через техподдержку GREEN-API support@green-api.com.

Перед запросом ключа партнёра рекомендуем ознакомиться с пунктом Подготовка и работа с личным кабинетом партнёра

Подготовка и работа с личным кабинетом партнёра#

  • Для работы с инстансами партнёра рекомендуем создать отдельный личный кабинет. Регистрацию кабинета произвести на корпоративную почту, так при увольнении сотрудника Вы не потеряете данные личного кабинета.

  • После переключения личного кабинета на работу с партнёрской программой (Вам выдается ключ партнёра), создание и удаление инстансов происходит через API или в личном кабинете.

  • Если в личном кабинете у Вас присутствуют инстансы тарифа Business они будут тарифицироваться по стандартной схеме (на инстансе может закончиться срок действия и производить продление необходимо оплатой на сайте), изменить тарификацию на партнёрскую невозможно.

  • Рекомендуем, после получения ключа партнёра удалить все существующие инстансы из личного кабинета и производить создание инстансов по API.

  • Для тестирования и настройки интеграции программисту необходимо использовать отдельный личный кабинет и инстансы тарифа Developer. Повышение квоты на создание инстансов происходит через канал технической поддержки.

Оплата партнёрского инстанса#

На инстансе с тарифом Партнёр действует система постоплаты. Партнёрам не нужно следить за балансом. При переходе на отрицательный баланс, инстансы продолжат работать как обычно. Создание инстансов также возможно даже при отрицательном балансе (оплата за инстанс списывается с баланса при создании, далее - посуточно в 00:00, utc +3). Ежемесячно мы рассылаем биллинги с расшифровкой по инстансам. Далее выставляем счет, если Вы оплачиваете по счету. Оплачивать счет за предыдущий месяц необходимо до 15 числа следующего за отчетным месяцем.

Тестирование методов#

Для проверки методов партнёров, рекомендуем использовать коллекцию Postman для партнёров.

Ключ партнёра имеет вид: gac.1234567891234567891234567891213456789

Для работы с коллекцией требуется предварительно получить API-ключ партнёра через техподдержку GREEN-API (support@green-api.com).

Справка по установке Postman

Формат запроса#

Обращение к API производится по адресу: 

{{partnerApiUrl}}/partner/{method}/{{partnerToken}}

{partnerApiUrl} - (string) - адрес хоста API, его можно найти в личном кабинете;

{method} - (string) - название метода API;

{partnerToken} - (string) - токен партнёра, получается отдельно через техподдержку GREEN-API;

Доступные методы API для партнёров#

getInstances - метод возвращает все инстансы аккаунтов созданных партнёром

createInstance - метод создания инстанса аккаунта мессенджера от имени партнёра

deleteInstanceAccount - метод удаляет инстанс аккаунта партнёра

Порядок работы#

  1. Создайте инстанс методом createInstance либо вручную в личном кабинете.

  2. Авторизуйте новый инстанс на телефоне. Для этого перейдите в личный кабинет и сканируйте QR-код.

    Дополнительно отображение QR-кода можно реализовать в интерфейсе Вашего программного продукта. Для этого рекомендуется воспользоваться примерами кода ниже:

    • Получение QR-кода через HTTP-запрос

    • Получение QR-кода через web-socket

    • Получение QR-кода в 1С

    • Получение QR-кода на отдельной странице в Интернете: 

      https://qr.green-api.com/waInstance{idInstance}/{apiTokenInstance}

    • Так же реализовано подключение по номеру телефона

    idInstance и apiTokenInstance могут быть получены методами createInstance и getInstances.

  3. Инстанс готов к работе. Для отправки и получения сообщений используйте методы API согласно документации