Elektron pochta marketing xizmatlari uchun API

Ushbu API tashqi e-mail xizmatlari bilan integratsiya qilish uchun ishlab chiqilgan. U yagona endpoint (masalan, https://yourserver.com/planfix_integration.php) orqali pochta ro'yxatlari va kontaktlarni boshqarishga imkon beradi va so'rovlarni JSON formatida qabul qiladi.

Integratsiyani amalga oshirgach, xizmatingizni Planfix interfeysida foydalanuvchilar uchun mavjud integratsiyalar ro'yxatiga qo'shish uchun bizning Support Service bilan bog'lanishingiz mumkin.

Planfix bilan ulanish

• Integratsiyani ulash va sozlash uchun Account management — Integrations — Email marketing bo'limiga o'ting.
• Ochilgan bo'limda ro'yxat oxirida Planfix API ni tanlang.
• Integratsiya sozlamalari oynasi ochiladi.
• Planfix so'rovlarni yuborishi kerak bo'lgan manzil va avtorizatsiya uchun API Key ni ko'rsatishingiz kerak.

So'rov formati

So'rov POST usuli orqali, integratsiya sozlamalarida ko'rsatilgan manzilga JSON formatida yuboriladi.

So'rov namunasi:

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

So'rov parametrlar:

Nomi	Tavsif	Tur/Ma'lumot formati	Eslatma
action	bajariladigan amal	string
authToken	API ga kirish uchun avtorizatsiya tokeni	string
data	amalga qarab uzatiladigan ma'lumotlar	object

Qo'llab‑quvvatlanadigan amallar

• createList — pochta ro'yxatini yaratish
• deleteList — pochta ro'yxatini o'chirish
• importContacts — ro'yxatga kontaktlarni import qilish
• updateContact — kontaktni yangilash

createList — Pochta ro'yxatini yaratish

Tavsif: Ko'rsatilgan nom bilan yangi pochta ro'yxatini yaratadi.

So'rov:

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

'Javob (muvaffaqiyat):

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

Javob (xato):

{
  "error": "Error description"
}

deleteList — Pochta ro'yxatini o'chirish

Tavsif: Ro'yxat identifikatori orqali pochta ro'yxatini o'chiradi.

So'rov:

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

Javob (muvaffaqiyat):

{
  "success": true
}

Javob (xato):

{
  "error": "Error description"
}

importContacts — Ro'yxatga kontaktlarni import qilish

Tavsif: Ko'rsatilgan pochta ro'yxatiga kontaktlarni import qiladi.

So'rov:

{
  "action": "importContacts",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "contacts": [
      {
        "id": 123,
        "email": "email@example.com",
        "firstName": "Name",
        "lastName": "Last name"
      }
    ]
  }
}

Javob (muvaffaqiyat):

{
  "success": true
}

Javob (xato):

{
  "error": "Error description"
}

updateContact — Kontaktni yangilash

Tavsif: Pochta ro'yxatidagi kontaktni yangilaydi. Qo'llab‑quvvatlanadigan amallar: add, update, delete.

So'rov:

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

Javob (muvaffaqiyat):

{
  "success": true
}

Javob (xato):

{
  "error": "Error description"
}

Muhim

• Barcha so'rovlarga JSON formatida javob qaytarilishi kerak.
• Xato yuz berganda, har doim xato tavsifini o'z ichiga olgan "error" maydoni bo'lishi shart.
• Muvaffaqiyat hollarda har doim "success": true maydoni bo'lishi kerak.
• Avtorizatsiya har bir so'rovda "authToken" maydoni orqali amalga oshiriladi.
• Barcha matn maydonlari UTF-8 kodlashida bo'lishi kerak.

O‘tish

• API