Партнёрка
Партнёрское API Radist.Online: профиль и промокоды партнёра, создание клиентов, подписки, реквизиты, счета, баланс, вознаграждения и выплаты.
Общее
Swagger: https://api.radist.online/v2/docs#/Partners
Необходимые доступы (scopes) для работы с API: partners
Доступ к этому API есть только у партнёрских компаний. Подробнее о партнёрке здесь.
Партнёр может
- Просматривать профиль партнёра (промокоды, вознаграждения, число активных клиентов)
- Просматривать список клиентов и информацию по ним, создавать новые компании-клиенты
- Отслеживать сроки действия подписок своих клиентов и изменять их размер/план
- Управлять своими реквизитами и реквизитами клиентов, использовать их для оплаты
- Выставлять счета на оплату своим клиентам и отслеживать их статусы
- Отслеживать баланс, вознаграждения и запрашивать выплаты
- Подписаться на уведомления о событиях своих клиентов, связанных с оплатой
Профиль
https://api.radist.online/v2/docs#/Partners/PartnersGetPartnerProfile (GET /profile/)
Пример получения профиля
| |
Клиент, воспользовавшийся promo_code при регистрации, будет привязан к партнёру как обычный клиент (partner_company_type=partner); воспользовавшийся referral_promo_code — как реферал (partner_company_type=referral). Вознаграждение (commissions) считается по-разному для этих двух типов.
Клиенты
Список клиентов
https://api.radist.online/v2/docs#/Partners/PartnersListPartnerCompanies (GET /partner_companies/)
Поддерживает поиск по имени/id (query), фильтры partner_company_type (partner/referral), subscription_type, subscription_status (PAID/TEST/NOT_PAID/FREE) и сортировку order_by (например, name:asc).
Пример получения списка клиентов
| |
Информация о клиенте
https://api.radist.online/v2/docs#/Partners/PartnersGetPartnerCompanyInfo (GET /partner_companies/{partner_company_id})
Заметка о клиенте
https://api.radist.online/v2/docs#/Partners/PartnersUpdatePartnerCompanyNote (PUT /partner_companies/{partner_company_id}/note/)
Пример обновления заметки
| |
Создание клиента
https://api.radist.online/v2/docs#/Partners/PartnersCreateClient (POST /clients/)
Требует право PARTNERS_CREATE_CLIENTS. Создаёт нового пользователя (по email) и компанию для него, привязанную к промокоду партнёра, и отправляет клиенту письмо с временным паролем. Число создаваемых в сутки клиентов ограничено.
Пример создания клиента
| |
Подписки клиентов
Список подписок клиента
https://api.radist.online/v2/docs#/Partners/PartnersListPartnerCompanySubscriptions (GET /partner_companies/{partner_company_id}/subscriptions/)
Пример получения списка подписок клиента
| |
Изменение размера подписки
https://api.radist.online/v2/docs#/Partners/PartnersChangePartnerCompanySubscriptionSize (POST /partner_companies/{partner_company_id}/subscriptions/{subscription_id}/actions/change_size)
Как и в обычных подписках, preview=true по умолчанию — считает результат без применения. new_max_size=0 требует target_subscription_id — все подключения будут перенесены в указанную подписку.
Пример изменения размера
| |
Изменение плана подписки
https://api.radist.online/v2/docs#/Partners/PartnersChangePartnerCompanySubscriptionPlan (POST /partner_companies/{partner_company_id}/subscriptions/{subscription_id}/actions/change_plan)
Пример изменения плана
| |
Реквизиты
Партнёр может использовать как реквизиты клиента, так и свои собственные (например, чтобы платить за клиентов со своего юрлица).
Реквизиты партнёра
- https://api.radist.online/v2/docs#/Partners/PartnersListPartnerRequisites (
GET /payments/requisites/) - https://api.radist.online/v2/docs#/Partners/PartnersCreatePartnerRequisite (
POST /payments/requisites/) - https://api.radist.online/v2/docs#/Partners/PartnersUpdatePartnerRequisite (
PUT /payments/requisites/{requisite_id}) - https://api.radist.online/v2/docs#/Partners/PartnersDeletePartnerRequisite (
DELETE /payments/requisites/{requisite_id})
Если реквизит создаётся как основной (default: true), обязательны bic и current_account (и kpp, если tin из 10 цифр).
Пример создания реквизита партнёра
| |
Реквизиты клиента
https://api.radist.online/v2/docs#/Partners/PartnersListPartnerCompanyRequisites (GET /partner_companies/{partner_company_id}/payments/requisites/)
Счета
Выставление счёта клиенту
https://api.radist.online/v2/docs#/Partners/PartnersCreatePartnerCompanyInvoice (POST /partner_companies/{partner_company_id}/payments/invoices/)
Тело запроса совпадает с обычным выставлением счёта, плюс:
partner_email— email партнёра, будет указан в чекеpartner_requisite_id— оплатить своими (партнёрскими) реквизитами вместо реквизитов клиента (payment_method=BANK_TRANSFER); ограничений на состав счёта нетuse_partner_balance— списать часть суммы с баланса партнёра
company_requisite_id (см. обычное выставление счёта) при выставлении счёта клиенту от партнёра можно использовать только если счёт только за WABA-диалоги — иначе будет ошибка SUBSCRIPTION_PAYMENTS_LOCKED. Для оплаты подписок реквизитами клиента используйте обычный эндпоинт счетов от имени самого клиента.
Пример выставления счёта клиенту
| |
company_id/company_name — клиент, для которого выставлен счёт. client_amount — сумма, которую увидит и оплатит клиент (может отличаться от amount, если применяется use_partner_balance).
Список счетов по всем клиентам
https://api.radist.online/v2/docs#/Partners/PartnersListPartnerCompaniesPayments (GET /partner_companies/payments/)
Поддерживает фильтры partner_company_id, partner_company_type и пагинацию (limit/offset).
Финансы
Баланс
https://api.radist.online/v2/docs#/Partners/PartnersGetPartnerCurrentBalance (GET /finance/balance/)
Пример получения баланса
| |
Вознаграждения
https://api.radist.online/v2/docs#/Partners/PartnersGetPartnerRewards (GET /finance/rewards/)
Вознаграждения начисляются за подписки клиентов (SUBSCRIPTIONS_REWARD) и за WABA-диалоги (WABA_DIALOGS_REWARD).
Пример получения списка вознаграждений
| |
Выплаты
https://api.radist.online/v2/docs#/Partners/PartnersGetPartnerPayouts (GET /finance/payouts/) — https://api.radist.online/v2/docs#/Partners/PartnersRequestPayout (POST /finance/payouts/)
Выплата запрашивается на один из реквизитов партнёра (см. выше) и переводит весь текущий баланс. Пока не набран минимальный баланс для выплаты, запрос вернёт ошибку PARTNER_PAYOUT_INSUFFICIENT_BALANCE; повторный запрос при уже активной выплате — PARTNER_PAYOUT_LOCKED.
Пример запроса выплаты
| |
Уведомления
Партнёр может подписаться на уведомления о событиях оплаты своих клиентов (сейчас единственный тип события — payment_status) через WhatsApp, Telegram, MAX или email.
- https://api.radist.online/v2/docs#/Partners/PartnersListPartnerNotificationChannels (
GET /notifications/channels/) - https://api.radist.online/v2/docs#/Partners/PartnersCreatePartnerNotificationChannel (
POST /notifications/channels/) - https://api.radist.online/v2/docs#/Partners/PartnersUpdatePartnerNotificationChannel (
PATCH /notifications/channels/{channel_id}) - https://api.radist.online/v2/docs#/Partners/PartnersDeletePartnerNotificationChannel (
DELETE /notifications/channels/{channel_id})
Для type=telegram и type=max в ответ на создание приходит не сам канал, а url (и qr_code) для подписки бота — канал появится в списке только после того, как клиент запустит бота по этой ссылке.
Пример подписки на уведомления (WhatsApp)
| |
params.partner_companies — список id клиентов, о которых нужны уведомления. Пустой список означает, что уведомления не будут приходить ни по одному клиенту — чтобы получать уведомления, нужно явно перечислить нужные id.