Просмотр кода страницы API для сервисов email-рассылок

{{#seo:
|title=API для сервисов email-рассылок
|titlemode=append
|keywords=планфикс, апи, api, email, api рассылок, api email-рассылок, api email
|description=API для сервисов email-рассылок
}}
Это API предназначено для интеграции с внешними сервисами электронной почты и позволяет управлять списками рассылки и контактами через единый конечный пункт (например, <nowiki>https://yourserver.com/planfix_integration.php</nowiki>), который принимает запросы в формате JSON.

После реализации интеграции вы можете обратиться в нашу <geoip eq="RU,BY">[https://planfix.ru/support/ Службу поддержки]</geoip><geoip not="RU,BY">[https://planfix.com/support/ Службу поддержки]</geoip> по вопросу добавления вашего сервиса в список интеграций, доступных пользователям в интерфейсе ПланФикса.

== Подключение в интерфейсе ПланФикса ==
*Перейдите в раздел Управление аккаунтом — Интеграции — Почтовая рассылка:
*В открывшемся разделе выберите находящиеся в конце списка Planfix API. 
*Откроется окно настроек интеграции.
*В нём надо будет указать адрес, куда ПланФикс будет слать запросы и API Key для авторизации.

== Формат запроса ==
Запрос передаётся методом POST в формате JSON на адрес, указанный в настройках интеграции.

'''Пример запроса:'''
<pre>
{
  "action": "действие",
  "authToken": "ваш_токен_авторизации",
  "data": {
    // Данные, зависящие от действия
  }
}
</pre>

'''Параметры запроса:'''
{| class="wikitable" style="margin-top: 1em; width:100%"
!width="150"|Имя !!width="50%"|Описание !!width="150"|Тип/формат данных !!Примечание
|-
|action ||Действие, которое необходимо выполнить ||string ||
|-
|authToken ||Токен авторизации для доступа к API ||string ||
|-
|data ||Данные, зависящие от действия ||object ||
|-
|}

== Поддерживаемые действия ==
*[[#createList — Создание списка рассылки|createList]] — cоздание списка рассылки
*[[#deleteList — Удаление списка рассылки|deleteList]] — удаление списка рассылки
*[[#importContacts — Импорт контактов в список|importContacts]] — импорт контактов в список
*[[#updateContact — Обновление контакта|updateContact]] — обновление контакта


=== createList — Создание списка рассылки ===
'''Описание:''' Создает новый список рассылки с указанным именем.

'''Запрос:'''
<pre>
{
  "action": "createList",
  "authToken": "ваш_токен_авторизации",
  "data": {
    "listName": "Название списка"
  }
}
</pre>

'''Ответ (успех):'''
<pre>
{
  "success": true,
  "listId": "уникальный_идентификатор_списка"
}
</pre>

'''Ответ (ошибка):'''
<pre>
{
  "error": "Описание ошибки"
}
</pre>


=== deleteList — Удаление списка рассылки ===
'''Описание:''' Удаляет список рассылки по его идентификатору.

'''Запрос:'''
<pre>
{
  "action": "deleteList",
  "authToken": "ваш_токен_авторизации",
  "data": {
    "listId": "идентификатор_списка"
  }
}
</pre>

'''Ответ (успех):'''
<pre>
{
  "success": true
}
</pre>

'''Ответ (ошибка):'''
<pre>
{
  "error": "Описание ошибки"
}
</pre>


=== importContacts — Импорт контактов в список ===
'''Описание:''' Импортирует контакты в указанный список рассылки.

'''Запрос:'''
<pre>
{
  "action": "importContacts",
  "authToken": "ваш_токен_авторизации",
  "data": {
    "listId": "идентификатор_списка",
    "contacts": [
      {
        "id": 123,
        "email": "email@example.com",
        "firstName": "Имя",
        "lastName": "Фамилия"
      }
    ]
  }
}
</pre>

'''Ответ (успех):'''
<pre>
{
  "success": true
}
</pre>

'''Ответ (ошибка):'''
<pre>
{
  "error": "Описание ошибки"
}
</pre>


=== updateContact — Обновление контакта ===
'''Описание:''' Обновляет контакт в списке рассылки. Поддерживает действия: добавление (add), обновление (update), удаление (delete).

'''Запрос:'''
<pre>
{
  "action": "updateContact",
  "authToken": "ваш_токен_авторизации",
  "data": {
    "listId": "идентификатор_списка",
    "action": "add|update|delete",
    "contact": {
      "id": 123,
      "email": "email@example.com",
      "firstName": "Имя",
      "lastName": "Фамилия"
    },
    "oldEmail": "старый_email@example.com" // только для action=update
  }
}
</pre>

'''Ответ (успех):'''
<pre>
{
  "success": true
}
</pre>

'''Ответ (ошибка):'''
<pre>
{
  "error": "Описание ошибки"
}
</pre>

== Важно ==
* Все запросы должны возвращать ответ в формате JSON.
* В случае ошибки всегда должно присутствовать поле "error" с описанием ошибки.
* В случае успеха всегда должно присутствовать поле "success": true.
* Авторизация происходит через поле authToken в каждом запросе.
* Все текстовые поля должны быть в кодировке UTF-8.

== Перейти ==
*[[Разработчикам: API]]