Электрондық пошта маркетингі қызметтеріне арналған АПЫ

Бұл АПЫ сыртқы электрондық пошта қызметтерін интеграциялау үшін әзірленген. Ол бір ендпоінт (мысалы, https://yourserver.com/planfix_integration.php) арқылы тізімдер мен контактілерді басқаруға мүмкіндік береді және сұрауларды ЖСОН форматында қабылдайды.

Интеграцияны жүзеге асырғаннан кейін, біздің Сұппорт Сервіце-ге хабарласып, қызметіңізді Планфіх интерфейсінде қолданушыларға қолжетімді интеграциялар тізіміне қосу туралы өтініш бере аласыз.

Планфіх-пен қосылу

Өтінішті қосу және баптау үшін Есептік жазба басқару — Интеграциялар — Емаіл маркетінг бөліміне өтіңіз.
Ашылған бөлікте тізімнің соңында Планфіх АПЫ таңдаңыз.
Интеграция баптаулары терезесі ашылады.
Планфіх сұраулар жіберетін мекенжайды және авторизация үшін АПЫ Кеy көрсетуіңіз керек.

Сұрау форматы

Сұрау ПОСТ әдісі арқылы интеграция баптауларында көрсетілген мекенжайға ЖСОН форматында жіберіледі.

Сұрау мысалы:

{
  "action": "action",
  "authToken": "your_authorization_token",
  "data": {
    // Data depending on the action
  }
}

Сұрау параметрлері:

Аты	Сипаттамасы	Тип/Деректер форматы
ацтіон	Орындауға тиіс әрекет	стрінг
аұтһТокен	АПЫ-ға рұқсат алу үшін авторизация токені	стрінг
дата	Әрекетке байланысты деректер	обжецт

Қолданылатын әрекеттер

цреатеЛіст — тарату тізімін құру
делетеЛіст — тарату тізімін жою
імпортЦонтацтс — контактілерді тізімге импорттау
ұпдатеЦонтацт — контактіні жаңарту

цреатеЛіст — Тарату тізімін құру

Сипаттама: Көрсетілген атаумен жаңа тарату тізімін құрады.

Сұрау:

{
  "action": "createList",
  "authToken": "your_authorization_token",
  "data": {
    "listName": "List name"
  }
}

'Жауап (сәтті):

{
  "success": true,
  "listId": "unique_list_identifier""
}

Жауап (қате):

{
  "error": "Error description"
}

делетеЛіст — Тарату тізімін жою

Сипаттама: Тарату тізімін оның идентификаторы бойынша жояды.

Сұрау:

{
  "action": "deleteList",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier"
  }
}

Жауап (сәтті):

{
  "success": true
}

Жауап (қате):

{
  "error": "Error description"
}

імпортЦонтацтс — Контактілерді тізімге импорттау

Сипаттама: Белгіленген тарату тізіміне контактілерді импорттайды.

Сұрау:

{
  "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"
}

ұпдатеЦонтацт — Контактіні жаңарту

Сипаттама: Тарату тізіміндегі контактіні жаңартады. Қолдайтын әрекеттер: адд, ұпдате, делете.

Сұрау:

{
  "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"
}

Маңызды

Барлық сұраулар ЖСОН форматында жауап қайтаруы тиіс.
Қате болған жағдайда әрқашан "еррор" өрісінде қате сипаттамасы көрсетілуі тиіс.
Сәттілік болған жағдайда әрқашан "сұццесс": трұе өрісі болуы тиіс.
Авторизация әр сұраудағы "аұтһТокен" өрісі арқылы жүзеге асады.
Барлық мәтіндік өрістер ҰТФ-8 кодтауында болуы тиіс.

Өту

АПЫ