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

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

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

Planfix-пен қосылу

• Өтінішті қосу және баптау үшін Есептік жазба басқару — Интеграциялар — Email marketing бөліміне өтіңіз.
• Ашылған бөлікте тізімнің соңында Planfix API таңдаңыз.
• Интеграция баптаулары терезесі ашылады.
• Planfix сұраулар жіберетін мекенжайды және авторизация үшін API Key көрсетуіңіз керек.

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

Сұрау 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 кодтауында болуы тиіс.

Өту

• API