ПланФикс API: Примеры вызова API используя curl — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
(не показано 15 промежуточных версий этого же участника) | |||
Строка 12: | Строка 12: | ||
− | == Добавление действия в задачу с номером 23525 в аккаунте testo.planfix.ru | + | == Добавление действия в задачу == |
+ | (с номером 23525 в аккаунте testo.planfix.ru) | ||
<source lang="bash"> | <source lang="bash"> | ||
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \ | curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \ | ||
− | -u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 | + | -u 583e3bcc38f34a4af6d8deadbeef8e2d:277ebe9f3a5770adeadbeefa2bc3dbb8 \ |
-d '<request method="action.add">\ | -d '<request method="action.add">\ | ||
<account>testo</account>\ | <account>testo</account>\ | ||
Строка 22: | Строка 23: | ||
<task><general>23525</general></task>\ | <task><general>23525</general></task>\ | ||
<description>текст действия</description>\ | <description>текст действия</description>\ | ||
− | + | </action></request>' \ | |
https://api.planfix.ru/xml/ | https://api.planfix.ru/xml/ | ||
</source> | </source> | ||
+ | |||
+ | |||
+ | == Добавление действия в задачу с html разметкой == | ||
+ | (с номером 23525 в аккаунте testo.planfix.ru ) | ||
+ | |||
+ | <source lang="bash"> | ||
+ | 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>строка раз<br>строка два<br><b>жирный текст</b></description>\ | ||
+ | </action></request>' \ | ||
+ | https://api.planfix.ru/xml/ | ||
+ | </source> | ||
+ | |||
+ | |||
+ | == Добавление действия к контакту == | ||
+ | (с номером 12300 в аккаунте testo.planfix.ru с html разметкой) | ||
+ | |||
+ | <source lang="bash"> | ||
+ | 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>строка раз<br>строка два<br><b>жирный текст</b></description>\ | ||
+ | </action></request>' \ | ||
+ | https://api.planfix.ru/xml/ | ||
+ | </source> | ||
+ | |||
+ | |||
+ | == Поиск контакта по номеру телефона == | ||
+ | (в аккаунте testo.planfix.ru) | ||
+ | |||
+ | <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>4003</type>\ | ||
+ | <operator>equal</operator>\ | ||
+ | <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> | ||
+ | |||
+ | |||
+ | == Перейти == | ||
+ | *[[XML API v1]] |
Текущая версия на 11:48, 11 декабря 2019
Приведем пару простых примеров для иллюстрации работы с ПланФикс API
Пусть в Управление аккаунтом / Доступ к API у нас следующие данные и создан один токен авторизации
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>строка раз<br>строка два<br><b>жирный текст</b></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>строка раз<br>строка два<br><b>жирный текст</b></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/