API для сервисов email-рассылок
Этот API разработан для интеграции с внешними сервисами email-маркетинга. Он позволяет управлять списками рассылки и контактами через одну конечную точку (например, https://yourserver.com/planfix_integration.php) и принимает запросы в формате JSON.
После настройки интеграции вы можете обратиться в нашу службу поддержки, чтобы добавить ваш сервис в список интеграций, доступных пользователям в интерфейсе Planfix.
Подключение к Planfix
- Перейдите в раздел Управление аккаунтом — Интеграции — Email-маркетинг, чтобы подключить и настроить интеграцию.
- В открывшемся разделе выберите Planfix API в конце списка.
- Откроется окно настроек интеграции.
- Укажите адрес, на который Planfix будет отправлять запросы, и API-ключ для авторизации.
Формат запроса
Запрос отправляется методом POST в формате JSON на адрес, указанный в настройках интеграции.
Пример запроса:
{
"action": "action",
"authToken": "your_authorization_token",
"data": {
// Data depending on the action
}
}
Параметры запроса:
| Название | Описание | Тип/формат данных | Примечание |
|---|---|---|---|
| action | Выполняемое действие | string | |
| authToken | Токен авторизации для доступа к API | string | |
| data | Данные, зависящие от действия | object |
Поддерживаемые действия
- createList — создать список рассылки
- deleteList — удалить список рассылки
- importContacts — импортировать контакты в список
- updateContact — обновить контакт
createList — Создание списка рассылки
Описание: Создает новый список рассылки с указанным названием.
Запрос:
{
"action": "createList",
"authToken": "your_authorization_token",
"data": {
"listName": "List name"
}
}
Ответ (успех):
{
"success": true,
"listId": "unique_list_identifier""
}
Ответ (ошибка):
{
"error": "Error description"
}
deleteList — Удаление списка рассылки
Описание: Удаляет список рассылки по его идентификатору.
Запрос:
{
"action": "deleteList",
"authToken": "your_authorization_token",
"data": {
"listId": "list_identifier"
}
}
Ответ (успех):
{
"success": true
}
Ответ (ошибка):
{
"error": "Error description"
}
importContacts — Импорт контактов в список
Описание: Импортирует контакты в указанный список рассылки.
Запрос:
{
"action": "importContacts",
"authToken": "your_authorization_token",
"data": {
"listId": "list_identifier",
"contacts": [
{
"id": 123,
"email": "email@example.com",
"firstName": "Name",
"lastName": "Last name"
}
]
}
}
Ответ (успех):
{
"success": true
}
Ответ (ошибка):
{
"error": "Error description"
}
updateContact — Обновление контакта
Описание: Обновляет контакт в списке рассылки. Поддерживаются действия: add, update, delete.
Запрос:
{
"action": "updateContact",
"authToken": "your_authorization_token",
"data": {
"listId": "list_identifier",
"action": "add|update|delete",
"contact": {
"id": 123,
"email": "email@example.com",
"firstName": "First name",
"lastName": "Last name"
},
"oldEmail": "old_email@example.com" // only for action=update
}
}
Ответ (успех):
{
"success": true
}
Ответ (ошибка):
{
"error": "Error description"
}
Важно
- Все запросы должны возвращать ответ в формате JSON.
- В случае ошибки поле "error" с описанием ошибки должно присутствовать всегда.
- В случае успеха поле "success": true должно присутствовать всегда.
- Авторизация выполняется с помощью поля "authToken" в каждом запросе.
- Все текстовые поля должны быть закодированы в UTF-8.