Интеграция по API для организатора партнерки

Описание процесса обработки реферальных ссылок

1. Партнер выкладывает на своих ресурсах ссылку на сайт Компании с вшитым уникальным кодом ref (например site.ru/page1?ref=12345). 
2. Ваш сайт должен отследить и сохранить в куки параметр ref.
3. Если посетитель подал заявку, то вы сохраняете этот ref из куки посетителя в CRM.
4. Ваша CRM отправляет API запрос в сервис для создания контакта /api/action/createcontact. Контакт привязывается к партнеру по указанному ref параметру. 
5. Когда этот клиент конвертируется и вы меняете его статус в CRM на клиент, ваша CRM вызывает метод /api/action/convertcontact. В сервисе контакт помечается как клиент и по нему полагается выплата партнеру за приведенного клиента. 
6. Когда этот клиент делает какие то дальнейшие заказы, ваша CRM через метод API /api/action/createorder отправляет информацию о заказе в сервис. Если это обозначено параметрами ПП, то партнеру полагается процент от заказа приведенного им клиента. 

Метод Создание контакта 

Создает контакт на сервисе с привязкой к партнеру по ref-параметру из ссылки партнера. 

URL  - https://runsarafan.ru/api/action/createcontact

POST запрос с Content-type application/json. 

Входные параметры:

• Http-заголовок Authorization = Basic {ключ из настроек ПП}
• Тело запроса в виде JSON с полями: 
  • ref - уникальный код партнера из ref параметра ссылки,
  • fio - ФИО контакта,
  • note - примечание,
  • email - email контакт,
  • phone - телефон контакта. 

Возвращает модель в виде JSON: 

• result - если 1, то операция успешна 
• msg - сообщение

Метод Конвертация контакта в клиента 

Конвертирует контакт на сервисе в клиента. 

URL  - https://runsarafan.ru/api/action/convertcontact

POST запрос с Content-type application/json. 

Входные параметры:

• Http-заголовок Authorization = Basic {ключ из настроек ПП}
• Тело запроса в виде JSON с полями: 
  • ref - уникальный код партнера из ref параметра ссылки,
  • email - email контакт,
  • phone - телефон контакта.

Контакт ищется по связке ref и телефон, email(достаточно сопадения телефона или email). 

Возвращает модель в виде JSON: 

• result - если 1, то операция успешна,
• msg - сообщение.

Метод Создание заказа

Создает заказ на сервисе для некоего контакта, которого привел партнер. 

URL  - https://runsarafan.ru/api/action/createorder

POST запрос с Content-type application/json. 

Входные параметры:

• Http-заголовок Authorization = Basic {ключ из настроек ПП}
• Тело запроса в виде JSON с полями: 
  • ref - уникальный код партнера из ref параметра ссылки,
  • email - email контакт, 
  • phone - телефон контакта,
  • total- общая сумма по заказу, 
  • num - номер заказа в вашей CRM (API проверяет уникальность номера заказа в пределах 1 контакта). 

По связке ref, телефон и почта определяется контакт, который сделал заказ и создается заказ в сервисе, привязанный к партнеру и контакту-клиенту, сделавшему этот заказ. 

Возвращает модель в виде JSON: 

• result - если 1, то операция успешна,
• msg - сообщение

Получение уведомлений в свою CRM о новых контактах и присоединение к ПП.

Указываем в настройках ПП адрес вебхука. 

Если он указан, то будет отправляться POST запрос при событиях Создание контакта и Присоединение партнера к ПП с набором данных в виде JSON. 

• code - тип события,
• itemID - id сущности (для кодов addContacts и joinProgram это programID),
• username - имя пользователя-инициатора уведомления,
• partnerID - id партнера,
• text - текст уведомления,
• data- дополнительные данные,
• programID - id программы, по которой идет событие.