Участники интеграции
- Дистрибьютор — (вы) юрлицо или ИП, владелец дистрибьюторской платформы, получающий вознаграждение дистрибьютора.
- Дистрибьюторская платформа — сайт, профиль в соцсетях, приложение, где происходит вознаграждаемое действие (пожертвование, донорство, волонтёрство), за которое нужно выдать вознаграждение и которое контролируется дистрибьютором.
- Некоммерческая организация (НКО) — организация, которая пользуется возможностями дистрибьюторской платформы, например размещает сборы и принимает пожертвования.
- Получатель — физлицо, которое совершает вознаграждаемые действия на дистрибьюторской платформе. Например, делает пожертвование, скачивает стикер-пак, рассказывает о сборе, ставит лайк и т.д.
- Вознаграждаемое действие — действие получателя, выполняя которое он получает возможность получить вознаграждение.
- Платформа вознаграждений — платформа fundraising.gifts, которая предоставляет страницу «Спасибо!» для интеграции в дистрибьюторскую платформу.
- Спонсор — физлицо или юрлицо, предоставляющее вознаграждения для получателей, отображаемые на странице «Спасибо!» платформы вознаграждений.
- Вознаграждение дистрибьютора — вознаграждение, которое выплачивает платформа вознаграждений дистрибьютору, когда получатели активируют предложения спонсоров на странице «Спасибо!».
Как интегрировать страницу «Спасибо!»
- Определите, в какие сценарии получателей будет интегрирована страница «Спасибо!». Чаще всего это:
- пожертвование;
- повышение уровня подписки;
- переход к регулярной помощи;
- распространение информации о сборе;
- скачивание стикеров и т.д.
- Определите, по каким вознаграждаемым действиям вы готовы делиться частью своего вознаграждения с НКО. Таких действий может не быть вообще, а могут быть все. Вы самостоятельно определяете их перечень и можете менять его в любой момент без согласования с платформой вознаграждений.
Обычно дистрибьюторы делятся вознаграждением, так как их НКО активно участвуют в том, чтобы на платформе дистрибьютора были получатели и они совершали вознаграждаемые действия (например, генерируют поток пожертвований), но это не обязательно.
- Запросите и получите свой уникальный идентификатор дистрибьютора, который используется в интеграции для того, чтобы привязывать действия получателей на платформе вознаграждений к дистрибьютору. Достаточно обратиться к контактному лицу, с которым вы взаимодействуете, чтобы получить идентификатор. Только за действия с вашим идентификатором может быть зачислено вознаграждение.
- Внесите изменения на своём сайте, в соцсетях, приложениях так, чтобы в выбранных сценариях получатели после совершения вознаграждаемых действий автоматически переходили по ссылке вида:
https://donor.gift/tools/nonprofit/thanks-page?partnerID=<partner_id>&distributorID=<distributor_id>где один обязательный параметр
distributorID(это ваш идентификатор дистрибьютора) и один опциональный параметрpartnerID(это идентификатор НКО, которая получит часть вознаграждения). Как получитьpartnerID, описано далее. - Проверьте внесённые изменения, самостоятельно пройдя по сценариям получателей, где была интеграция. Дистрибьюторское вознаграждение зачисляется только в том случае, если в ссылке был передан корректный
distributorID, так как только в этом случае возможно однозначно определить источник вознаграждаемого действия.
Как использовать и получить partnerID
Это динамический опциональный параметр, который нужно использовать, если вы хотите поделиться вознаграждение с НКО и его нужно подменять в зависимости от того, благодаря какой НКО произошло вознаграждаемое действие. Два примера:
- На вашем сайте есть страница со сбором. Этот сбор организовала и продвигает ваша НКО. Если получатель совершил пожертвование на этот сбор, то в ссылку подставляете
partnerIDэтой организации-партнёра. - На вашем сайте есть страница НКО со списком её сборов. Если получатель жертвует самой НКО, а не конкретному её сбору, то в ссылку подставляете
partnerIDэтой организации-партнёра.
Получается, если в конкретном сценарии получателей вы можете определить, какая конкретная НКО сейчас связана с действиями получателей, то в этом случае вы можете подставлять partnerID и тем самым делиться своим вознаграждением.
Чтобы узнать, какой partnerID у конкретной НКО, нужно знать её ИНН/ОГРН и сделать GET-запрос на https://fundraising.gifts/api/public/distributors/organizations?search=<ИНН или ОГРН>, который вернёт готовый к использованию идентификатор. Вознаграждение получит та организация, чей идентификатор будет передан в partnerID.
Пример запроса:
https://fundraising.gifts/api/public/distributors/organizations?search=6324119053
Пример ответа — значение data.id подставляется в partnerID:
{
"data": {
"id": "bcc1a8a2-4c4f-415b-a80c-ee5ca4eede07"
}
}
Единожды полученный partnerID никогда не меняется, и его не нужно повторно когда-либо обновлять.
Параметры страницы
Страница поддерживает следующие параметры. Обязательный — только distributorID, остальные добавляйте к ссылке в любом сочетании. В каждый необязательный параметр можно подставить значение, связанное с конкретной НКО (её логотип, её цвет, её название в заголовке), либо использовать фирменные значения своей дистрибьюторской платформы — оба варианта корректны.
| Параметр | Описание | Обязательность | По умолчанию | Пример |
|---|---|---|---|---|
distributorID | Ваш идентификатор дистрибьютора. Вознаграждение начисляется только если в ссылке передан корректный идентификатор. | Обязательный. | — | distributorID=01970452-3b1a-7f2c-9d4e-5a6b7c8d9e0f |
partnerID | Идентификатор НКО, которая получит часть вознаграждения. Как получить — в разделе выше. | Необязательный. | — | partnerID=01970453-4c2b-8a3d-1e5f-6b7c8d9e0f1a |
logoURL | Ссылка на логотип в шапке страницы. Если не указан, показывается название НКО. | Необязательный. | — | logoURL=https://example.org/logo.svg |
color | Основной цвет страницы в формате HEX, символ # можно опускать. Если не указан, а передан logoURL, цвет извлекается из логотипа автоматически. | Необязательный. | #ec4899 | color=ec4899 |
titleText | Заголовок страницы. | Необязательный. | Спасибо за помощь! | titleText=Спасибо! |
Пример ссылки с логотипом и цветом:
https://donor.gift/tools/nonprofit/thanks-page?partnerID=<partner_id>&distributorID=<distributor_id>&logoURL=https://example.org/logo.svg&color=ec4899
Куда обращаться за технической и продуктовой помощью
Пожалуйста, напишите письмо на distributors@fundraising.gifts. Мы помогаем по всем техническим вопросам интеграции.