ПланФикс API: Примеры вызова API используя curl: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
(не показано 8 промежуточных версий этого же участника)
Строка 12: Строка 12:




== Добавление действия в задачу ==
== Добавление комментария в задачу ==
(с номером 23525 в аккаунте testo.planfix.ru)
(с номером 23525 в аккаунте testo.planfix.ru)


Строка 22: Строка 22:
<action>\
<action>\
<task><general>23525</general></task>\
<task><general>23525</general></task>\
<description>текст действия</description>\
<description>текст комментария</description>\
</action></request>' \
</action></request>' \
https://api.planfix.ru/xml/
https://api.planfix.ru/xml/
Строка 28: Строка 28:




== Добавление действия в задачу с html разметкой ==
== Добавление комментария в задачу с html разметкой ==
(с номером 23525 в аккаунте testo.planfix.ru )
(с номером 23525 в аккаунте testo.planfix.ru )


Строка 44: Строка 44:




== Добавление действия к контакту ==
== Добавление комментария к контакту ==
(с номером 12300 в аккаунте testo.planfix.ru с html разметкой)
(с номером 12300 в аккаунте testo.planfix.ru с html разметкой)


Строка 74: Строка 74:
<operator>equal</operator>\
<operator>equal</operator>\
<value>123456</value>\
<value>123456</value>\
</filter></filters></request>' \
https://api.planfix.ru/xml/
</source>
== Поиск контакта по значению поля типа строка ==
(с идентификатором поля 10123, в аккаунте testo.planfix.ru)
(идентификаторы полей можно получить методом [[ПланФикс API contact.get|contact.get]] на шаблоне контакта с этим полем)
<source lang="bash">
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="contact.getList">\
<account>testo</account>\
<pageCurrent>1</pageCurrent>\
<pageSize>10</pageSize>
<filters><filter>\
<type>4101</type>\
<field>10123</field>\
<operator>equal</operator>\
<value>value_fo_find</value>\
</filter></filters></request>' \
https://api.planfix.ru/xml/
</source>
== Поиск задачи по значению поля типа строка ==
(с идентификатором поля 10123, в аккаунте testo.planfix.ru)
(идентификаторы полей можно получить методом [[ПланФикс API task.get|task.get]] на шаблоне задачи с этим полем, справка фильтрам - [[ПланФикс API:Фильтры задач]])
<source lang="bash">
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="task.getList">\
<account>testo</account>\
<pageCurrent>1</pageCurrent>\
<pageSize>10</pageSize>
<filters><filter>\
<type>101</type>\
<field>10123</field>\
<operator>equal</operator>\
<value>value_fo_find</value>\
</filter></filters></request>' \
</filter></filters></request>' \
https://api.planfix.ru/xml/
https://api.planfix.ru/xml/

Текущая версия от 12:38, 31 августа 2023

Приведем пару простых примеров для иллюстрации работы с ПланФикс API

Пусть в Управление аккаунтом / Доступ к API у нас следующие данные и создан один токен авторизации

tUa3VT.jpg


APIKey = 583e3bcc38f34a4af6d8deadbeef8e2d

Токен = 277ebe9f3a5770adeadbeefa2bc3dbb8


Добавление комментария в задачу

(с номером 23525 в аккаунте testo.planfix.ru)

curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="action.add">\
<account>testo</account>\
<action>\
<task><general>23525</general></task>\
<description>текст комментария</description>\
</action></request>' \
https://api.planfix.ru/xml/


Добавление комментария в задачу с html разметкой

(с номером 23525 в аккаунте testo.planfix.ru )

curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="action.add">\
<account>testo</account>\
<action>\
<task><general>23525</general></task>\
<description>строка раз&lt;br&gt;строка два&lt;br&gt;&lt;b&gt;жирный текст&lt;/b&gt;</description>\
</action></request>' \
https://api.planfix.ru/xml/


Добавление комментария к контакту

(с номером 12300 в аккаунте testo.planfix.ru с html разметкой)

curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="action.add">\
<account>testo</account>\
<action>\
<contact><general>12300</general></contact>\
<description>строка раз&lt;br&gt;строка два&lt;br&gt;&lt;b&gt;жирный текст&lt;/b&gt;</description>\
</action></request>' \
https://api.planfix.ru/xml/


Поиск контакта по номеру телефона

(в аккаунте testo.planfix.ru)

curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="contact.getList">\
<account>testo</account>\
<pageCurrent>1</pageCurrent>\
<pageSize>10</pageSize>
<filters><filter>\
<type>4003</type>\
<operator>equal</operator>\
<value>123456</value>\
</filter></filters></request>' \
https://api.planfix.ru/xml/

Поиск контакта по значению поля типа строка

(с идентификатором поля 10123, в аккаунте testo.planfix.ru) (идентификаторы полей можно получить методом contact.get на шаблоне контакта с этим полем)

curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="contact.getList">\
<account>testo</account>\
<pageCurrent>1</pageCurrent>\
<pageSize>10</pageSize>
<filters><filter>\
<type>4101</type>\
<field>10123</field>\
<operator>equal</operator>\
<value>value_fo_find</value>\
</filter></filters></request>' \
https://api.planfix.ru/xml/

Поиск задачи по значению поля типа строка

(с идентификатором поля 10123, в аккаунте testo.planfix.ru) (идентификаторы полей можно получить методом task.get на шаблоне задачи с этим полем, справка фильтрам - ПланФикс API:Фильтры задач)

curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \
-d '<request method="task.getList">\
<account>testo</account>\
<pageCurrent>1</pageCurrent>\
<pageSize>10</pageSize>
<filters><filter>\
<type>101</type>\
<field>10123</field>\
<operator>equal</operator>\
<value>value_fo_find</value>\
</filter></filters></request>' \
https://api.planfix.ru/xml/


Перейти