taswwg

مدونة متخصصة | في مجال التسويق الرقمي | وجميع مجالاته الأفلييت ماركتنج , الدروبشيبنج , التجارة الإلكترونية.

LightBlog

اخبار عاجلة

إضافة جهات اتصال في GetResponse مفتاح API GetResponse طرريقة إضافة جهات اتصال في GetResponse وأين أجد مفتاح API في GetResponse؟

طرريقة إضافة جهات اتصال في GetResponse وأين أجد مفتاح API في GetResponse؟

in , ,


يمكنك إضافة جهات اتصال عبر طريقة POST / Contacts .

معرف الحملة

في GetResponse ، تقوم بإضافة جهات اتصال إلى حملة (قائمة) محددة. للقيام بذلك ، احصل أولاً على معرف الحملة (القائمة).
هناك طريقتان للعثور على معرف (قائمة) الحملة المتوافقة مع API:
  • من خلال البحث عنه في إعدادات القائمة في حسابك
  • من خلال API.
ابحث عن معرّف الحملة (القائمة) في إعدادات القائمة
  1. تسجيل الدخول إلى حسابك.
  2. انقر فوق جهات الاتصال أو استخدم هذا الاختصار لعرض قوائم جهات الاتصال الخاصة بك.
  3. قم بالتمرير للعثور على القائمة.
  4. انقر على أيقونة الإجراءات (الدرس الرأسي) وحدد الإعدادات .
  5. في عام التبويب، يمكنك العثور على قيمة LIST TOKEN تحت اسم القائمة المجال.
ابحث عن معرف الحملة من خلال API
  1. استدعاء طريقة GET / الحملات .
  2. ابحث عن الحملة المستهدفة ضمن استجابة JSON.
يتم إرجاع معرفات الحملات المتوافقة مع API في campaignIdالحقول.

الحقول المخصصة

تسمح لك الحقول المخصصة بإضافة وتخزين أي معلومات إضافية حول جهات الاتصال الخاصة بك.
في واجهة برمجة التطبيقات ، يحتوي كل حقل مخصص على معرف فريد. لاسترداد قائمة الحقول المخصصة الخاصة بك ، تحتاج إلى استدعاء أسلوب GET / الحقول المخصصة . قد يبدو الرد كما يلي:
[
  {
    "customFieldId": "y8jnp",
    "href": "https://api.getresponse.com/v3/custom-fields/y8jnp",
    "name": "age",
    "fieldType": "single_select",
    "valueType": "string",
    "type": "single_select",
    "hidden": "false",
    "values": [
      "18-29",
      "30-44",
      "45-59",
      "60+",
      "<18"
    ]
  },
  {
    "customFieldId": "z9Kgt",
    "href": "https://api.getresponse.com/v3/custom-fields/z9Kgt",
    "name": "city",
    "fieldType": "text",
    "valueType": "string",
    "type": "text",
    "hidden": "false",
    "values": []
  }
] 
تتضمن هذه الاستجابة حقلين مخصصين: العمر (معرف الحقل y8jnp) والمدينة (معرف الحقل z9Kgt).

إضافة جهة اتصال

استخدم طريقة POST / Contacts لإضافة جهات اتصال.
تذكر أن جميع الطرق تقبل بيانات JSON وتعيدها فقط.

حمولة JSON الأساسية

في المثال التالي ، لنستخدم معرّف الحملة p86zQ:
{
  "email": "example@example.com",
  "campaign": {
    "campaignId": "p86zQ"
  }
}
سيؤدي الطلب بالحمولة أعلاه إلى إنشاء جهة اتصال جديدة في الحملة p86zQوضبط البريد الإلكتروني لجهة الاتصال على example@example.com. لن تتم إضافة جهة الاتصال إلى دورة الرد الآلي ، ولن يتم تعيين أي حقول مخصصة لها ، ولن يتم تحديد الموقع الجغرافي لها ، وستتلقى الاسم الافتراضي: "صديق".

أكمل حمولة JSON

فيما يلي مثال باستخدام جميع المجالات:
{
  "name": "John Smith",
  "email": "example@example.com",
  "dayOfCycle": "0",
  "campaign": {
    "campaignId": "p86zQ"
  },
  "customFieldValues": [
    {
      "customFieldId": "y8jnp",
      "value": ["18-29"]
    },
    {
      "customFieldId": "z9Kgt",
      "value": ["Podunk"]
    }
  ],
  "ipAddress": "192.168.0.1"
}
ستقوم جهة الاتصال الجديدة بما يلي:
  • تم تعيين الاسم على John Smith
  • ضبط البريد الإلكتروني على example@example.com
  • يضاف إلى دورة الرد الآلي في اليوم 0
  • تضاف إلى الحملة p86zQ
  • لديك حقلين مخصصين:
    • العمر مضبوط على 18-29
    • المدينة ، تعيين Podunk
  • احصل على عنوان IP 192.168.0.1الذي سيتم استخدامه لتحديد الموقع الجغرافي لجهة الاتصال.

الاستجابة والمعالجة

في حالة نجاح الطلب ، تُرجع واجهة برمجة التطبيقات رمز HTTP 202 المقبول. هذا يعني أنه تم التحقق من صحة جهة الاتصال مبدئيًا وإضافتها إلى قائمة الانتظار. قد يستغرق الأمر بضع دقائق لمعالجة قائمة الانتظار وإضافة جهة الاتصال إلى القائمة. إذا لم تظهر جهة الاتصال الخاصة بك في القائمة ، فمن المحتمل أن يكون قد تم رفضها في مرحلة لاحقة من المعالجة.

الاشتراك المزدوج

إذا تم تعيين قائمتك على الاشتراك المزدوج ، فيجب على جهة الاتصال النقر فوق ارتباط في رسالة تأكيد لإضافتها إلى قائمتك. لا يتم إرجاع جهات الاتصال غير المؤكدة بواسطة واجهة برمجة التطبيقات ويمكن العثور عليها باستخدام بحث جهات الاتصال فقط.

أخطاء

استجابة الخطأ

لنأخذ مثال الخطأ هذا:
{
  "httpStatus": 400,
  "code": 1000,
  "codeDescription": "General error of validation process, more details should be in context section",
  "message": "Custom field invalid",
  "moreInfo": "https://apidocs.getresponse.com/en/v3/errors/1000",
  "context": [
    "Empty value. ID: y8jnp"
  ],
  "uuid": "5a42dd48-7f57-4919-9b32-391e594ce375"
}
لاحظ الحقول التالية:
  • codeDescription - وصف رمز الخطأ العام
  • message - رسالة خطأ
  • moreInfo - رابط إلى مستندات API لدينا مع معلومات إضافية حول تفاصيل الخطأ
  • context - الحقل و / أو القيمة التي تسببت في المشكلة ، تفاصيل الخطأ الإضافية ، إلخ.

الأخطاء الشائعة

خطأ تحقق عام - HTTP 400 - الرمز 1000
بيانات الطلب غير صالحة. يتم توفير معلومات مفصلة عن الخطأ في هذا contextالمجال.
لم يتم العثور على المورد ذي الصلة - HTTP 400 - الرمز 1001
تأكد من صحة معرف الحملة ومعرفات الحقول المخصصة.
تحظر حالة الموارد هذا النوع من الإجراءات - HTTP 400 - الرمز 1002
يرجى الرجوع إلى قسم السياق في استجابة الخطأ للحصول على شرح مفصل. قد تشمل الأسباب ما يلي:
  • يتم إدراج جهة الاتصال في القائمة السوداء في الحملة أو الحساب أو القائمة السوداء العالمية.
  • عنوان البريد الإلكتروني غير صالح - المجال غير موجود أو لا يمكن العثور على المستخدم.
  • تم حذف جهة الاتصال أو ارتدادها.
المعلمة لها تنسيق خاطئ - HTTP 400 - الرمز 1003
تأكد من تنسيق جميع القيم بشكل صحيح. إيلاء اهتمام خاص ل valueفي customFieldValues- يجب أن يكون صفيف، حتى إذا كنت ترغب في تعيين قيمة واحدة فقط.
حقل مطلوب فارغ - HTTP 400 - الرمز 1005
مطلوب حقلين فقط عند إضافة جهة اتصال جديدة - emailو campaignId(متداخل في campaign). تأكد من تعيين كلاهما.
مورد آخر له نفس قيمة الخاصية الفريدة - HTTP 409 - الرمز 1008
يمكن إضافة عنوان بريد إلكتروني معين مرة واحدة فقط إلى الحملة. ومع ذلك ، لا يزال بإمكانك إضافة نفس جهة الاتصال إلى حملات مختلفة .

الأخطاء الشائعة

معرّف الحملة الرقمية
 للحصول على campaignIdالقيمة ، استخدم TOKEN الأبجدي الرقمي المقدم تحت اسم الحملة في قائمة الحملات . لا تستخدم رقم الحملة المكون من 8 أرقام.

اسم الحقل المخصص في customFieldValues

customFieldIdيجب أن يحتوي على معرف الحقل المخصص الذي تم إرجاعه بواسطة GET / الحقول المخصصة . لا تستخدم اسم الحقل المخصص.

cycle_day حقل

اسم الحقل الصحيح لإضافة جهة اتصال إلى يوم محدد في دورة الرد الآلي هو dayOfCycle. يستخدم API نهج متساهل ضد الحقول غير المعروفة في الطلبات ، لذلك cycle_dayلن ينتج عن استخدام خطأ. بدلاً من ذلك ، سيتم تجاهل الحقل ولن تتم إضافة جهة الاتصال إلى دورة الرد الآلي.

أين أجد مفتاح API  في GetResponse؟

يمكنك العثور عليها ضمن القائمة >> عمليات التكامل >> واجهة برمجة التطبيقات . للحصول على مفتاحك:

  • 1. انقر على زر إنشاء واجهة برمجة التطبيقات .
موقف زر إنشاء واجهة برمجة التطبيقات

  • 2. قم بتسمية المفتاح الخاص بك. الاسم متروك لك. من الجيد استخدام اسم يساعدك على تتبع جميع مفاتيح API التي تنشئها.
لأسباب تتعلق بالسلامة ، نوصي بإنشاء مفتاح API مختلف لكل عملية دمج تقوم بإنشائها.

يجب إبقاء هذا المفتاح سريًا مثل كلمة المرور - لا تشاركه مع أي شخص. وثائق المطورين متاحة في صفحة ApiDocs .


قسم , ,