Работа с API PrimeGate

Через API вы сможете создавать/редактировать/удалять контакты/лиды/сделки.

Для начала работы вам необходимо получить API ключ на странице и ID вашего проекта по ссылке, для обращения к API необходимо передавать POST запросы, так например для создания контакта вам необходимо передать POST запрос по адресу https://api.primegate.io/v2/contact/create?site_id=ваш_ид&key=ваш_ключ

‍

Необходимо обязательно передавать параметр out_id, который содержит ID записи в вашей системе!

Пример данных для создания контакта:
‍

curl -X POST "https://api.primegate.io/v2/contact/create?site_id=XX&key=YY" --data 'items%5B0%5D%5Bfields%5D%5Bout_id%5D=111&items%5B0%5D%5Bfields%5D%

5Bsession_id%5D=239219&items%5B0%5D%5Bfields%5D%5Bname%5D=textcontac

t&items%5B0%5D%5Bfields%5D%5Bphone%5D=89999999999'

‍

Таким же образом необходимо работать со сделками и лидами

https://api.primegate.io/v2/lead/create

Пример:

‍

curl -X POST "https://api.primegate.io/v2/lead/create?site_id=XX&key=YY" --data 'items%5B0%5D%5Bfields%5D%5Bout_id%5D=222&items%5B0%5D%5Bfields%5D%

5Bvisitor_id%5D=9017289&items%5B0%5D%5Bfields%5D%5Bsession_id%
5D=239219&items%5B0%5D%5Bfields%5D%5Bcontact_out_id%5D=333&items%

5B0%5D%5Bfields%5D%5Bcontact_id%5D=443447&items%5B0%5D%5Bfields%5D%

5Bchannel%5D=3&items%5B0%5D%5Bfields%5D%5Bphone%5D=89999999999'

https://api.primegate.io/v2/deal/create

Пример:

‍
curl -X POST "https://api.primegate.io/v2/deal/create?site_id=XX&key=YY" --data 'items%5B0%5D%5Bfields%5D%5Bout_id%5D=333&items%5B0%5D%5Bfields%5D%

5Blead_out_id%5D=444&items%5B0%5D%5Bfields%5D%5Blead_id%5D=414043&

items%5B0%5D%5Bfields%5D%5Bcontact_out_id%5D=111&items%5B0%5D%5Bfields%

5D%5Bcontact_id%5D=443447&items%5B0%5D%5Bfields%5D%5Bbudget%5D=500

&items%5B0%5D%5Bfields%5D%5Bout_pipeline_id%5D=777&items%5B0%5D%5Bfiel

ds%5D%5Bout_stage_id%5D=123777'
‍

Для редактирования и удаления необходимо использовать методы update, delete, например:

https://api.primegate.io/v2/lead/update

‍

Для получения списка необходимо использовать метод get, передав туда параметры в следующем формате:

‍

‍

‍

Также возможно использовать операторы >, <, >=, <=, !=, like, для этого отправьте следующее содержание query:

‍

‍

Данные, которые можно прислать для контакта:

‍

1. out_id* int
2. visitor_id int
3. session_id int
4. name string
5. email string
6. phone string
7. city string

‍

Данные, которые можно прислать для лида:

‍

1. out_id* int
2. visitor_id int
3. session_id int
4. contact_out_id int ID контакта во внешней системе
5. contact_id int (в нашей системе)
6. channel int Тип лида, например входящий звонок или форма (см. описание ниже)
7. phone string
8. email string
9. note string
10. source string
11. traffic_channel string
12. ad_content string
13. keyword string
14. ad_campaign string

‍

Данные, которые можно прислать для сделки:

‍

1. out_id* int
2. lead_out_id int ID лида во внешней системе
3. lead_id int (в нашей системе)
4. contact_out_id int ID контакта во внешней системе
5. contact_id int (в нашей системе)
6. pipeline_id int (в нашей системе)
7. stage_id int(в нашей системе)
8. out_pipeline_id varchar (id воронки во внешней системе)
9. out_stage_id varchar (id этапа во внешней системе)
10. ‍description string
11. budget double

При одновременной отправке stage_id, pipeline_id,out_pipeline_id,out_stage_id - преимущество отдается stage_id и pipeline_id

‍

Возможные значения для параметра channel в сущности лид

‍

0 - Не определенный канал

1 - Звонок (входящий, исходящий, пропущенный), использовать параметры 7, 8, 9

2 - Колбэк

3 - Форма

4 - Чат

5 - Эл. письмо

6 - Корзина

7 - Входящий звонок

8 - Исходящий звонок

9 - Пропущенный звонок

10 - Offline лид

Дополнительную информацию по методам получения списка сущностей ищите здесь.