Segment

المقدمة

يرسل تكامل Segment أحداث Dodo Payments إلى HTTP Tracking API الخاص بـ Segment كاستدعاءات Track وIdentify. ثم يمرر Segment بيانات المدفوعات والاشتراكات والعملاء إلى أدوات التحليلات والتسويق ومستودعات البيانات المتصلة بمساحة العمل لديك، من كتالوج يضم أكثر من 300 وجهة.

يتطلب هذا التكامل Write Key لمصدر HTTP API في مساحة عمل Segment لديك. كما تحتاج إلى الوصول إلى Developer → Webhooks في لوحة تحكم Dodo Payments.

البدء

Open the Webhook Section

في لوحة تحكم Dodo Payments، انتقل إلى Developer → Webhooks وانقر على Add endpoint.

مربع حوار إضافة نقطة نهاية مع تحديد Segment في القائمة المنسدلة Integration وخطوات How to connect Segment

Select Segment

في Integration، حدد Segment. تملأ لوحة التحكم Endpoint URL ورمز التحويل الخاص بـ Segment.

Enter Write Key

في Segment، انتقل إلى Connections → Sources وافتح مصدر HTTP API أو أنشئه. انسخ Write Key من إعدادات المصدر والصقه في API key.

Select Events

في Subscribed events، حدد الأحداث التي يتعامل معها التحويل فقط. تستخدم الأمثلة في هذه الصفحة payment.succeeded وsubscription.active وsubscription.cancelled.

Configure Transformation

ضمن Transformation code، عدّل المعالج لتنسيق الأحداث وفق Track أو Identify API الخاص بـ Segment. ابدأ من الأمثلة.

Test & Create

ضمن Test this code، حدد نوع حدث وانقر على Simulate لمعاينة الاستدعاء إلى Segment. ثم انقر على Create endpoint.

Switch to Basic Authentication

يرسل Dodo Payments قيمة API key كرمز bearer، لكن HTTP API الخاص بـ Segment يقبل Write Key من خلال Basic authentication أو حقل writeKey في النص. بعد إنشاء نقطة النهاية مباشرةً، افتح علامة التبويب Advanced الخاصة بها. ضمن Custom headers، أدخل قيمة جديدة في الصف المخفي Authorization: Basic، ثم مسافة، ثم ترميز Base64 الخاص بـ Write Key مع إضافة نقطتين. بعد ذلك انقر على Save. على سبيل المثال، يطبع echo -n 'YOUR_WRITE_KEY:' | base64 القيمة المُرمّزة.

Done

تصل الأحداث المشترَك بها الآن إلى Segment، الذي يمررها إلى الوجهات المتصلة لديك.

أمثلة على Transformation Code

يعيّن كل معالج webhook.url إلى نقطة نهاية Segment API ويستبدل webhook.payload بالاستدعاء. تكون مبالغ Dodo Payments بوحدة العملة الأصغر، لذلك تقسم الأمثلة المبلغ على 100. بالنسبة إلى العملات ذات المنازل العشرية الصفرية مثل JPY وKRW، استخدم المبلغ كما هو.

تتبّع أحداث الدفع

سجّل حدث Payment Completed عند نجاح عملية الدفع:

track_payments.js

function handler(webhook) {
  if (webhook.eventType === "payment.succeeded") {
    const p = webhook.payload.data;
    webhook.url = "https://api.segment.io/v1/track";
    webhook.payload = {
      userId: p.customer.customer_id,
      event: "Payment Completed",
      properties: {
        amount: (p.total_amount / 100).toFixed(2),
        currency: p.currency || "USD",
        payment_method: p.payment_method || "unknown",
        payment_id: p.payment_id,
        customer_email: p.customer.email,
        customer_name: p.customer.name
      },
      timestamp: webhook.payload.timestamp
    };
  }
  return webhook;
}

تتبّع دورة حياة الاشتراك

سجّل أحداث Subscription Started وSubscription Cancelled:

track_subscriptions.js

function handler(webhook) {
  const s = webhook.payload.data;
  switch (webhook.eventType) {
    case "subscription.active":
      webhook.url = "https://api.segment.io/v1/track";
      webhook.payload = {
        userId: s.customer.customer_id,
        event: "Subscription Started",
        properties: {
          subscription_id: s.subscription_id,
          product_id: s.product_id,
          amount: (s.recurring_pre_tax_amount / 100).toFixed(2),
          frequency: s.payment_frequency_interval,
          next_billing: s.next_billing_date,
          customer_email: s.customer.email
        },
        timestamp: webhook.payload.timestamp
      };
      break;
    case "subscription.cancelled":
      webhook.url = "https://api.segment.io/v1/track";
      webhook.payload = {
        userId: s.customer.customer_id,
        event: "Subscription Cancelled",
        properties: {
          subscription_id: s.subscription_id,
          product_id: s.product_id,
          cancelled_at: s.cancelled_at,
          cancel_at_next_billing: s.cancel_at_next_billing_date,
          customer_email: s.customer.email
        },
        timestamp: webhook.payload.timestamp
      };
      break;
  }
  return webhook;
}

تحديد خصائص العميل

حدّث سمات العميل بعد كل عملية دفع ناجحة. يعيّن كل استدعاء Identify السمات إلى القيم التي يرسلها، لذلك تصف هذه السمات أحدث عملية دفع:

identify_customer.js

function handler(webhook) {
  if (webhook.eventType === "payment.succeeded") {
    const p = webhook.payload.data;
    webhook.url = "https://api.segment.io/v1/identify";
    webhook.payload = {
      userId: p.customer.customer_id,
      traits: {
        email: p.customer.email,
        name: p.customer.name,
        last_payment_amount: (p.total_amount / 100).toFixed(2),
        payment_method: p.payment_method || "unknown",
        last_payment_date: webhook.payload.timestamp
      }
    };
  }
  return webhook;
}

نصائح

استخدم أسماء أحداث متسقة في أنحاء التكامل، مثل تنسيق الكائن والإجراء الخاص بـ Segment في Payment Completed.
أدرج الخصائص التي تحتاج إليها للتحليلات وتقسيم الجمهور.
عيّن timestamp من timestamp الخاص بالحدث، لكي يسجل Segment وقت وقوع الحدث بدلًا من وقت وصوله.
استخدم customer_id الخاص بـ Dodo Payments بوصفه userId، حتى يرتبط كل استدعاء لعميل بالـ Segment user نفسه.

استكشاف الأخطاء وإصلاحها

Events Not Appearing in Segment

تحقق من أن Write Key ينتمي إلى مصدر HTTP API وأن ترويسة Authorization تستخدم Basic authentication.
يعيد Segment 200 لمعظم الطلبات، بما في ذلك الطلبات التي لا يقبلها، لذلك لا يثبت التسليم الناجح في سجلات Dodo Payments وصول الحدث. تحقق من Debugger الخاص بالمصدر في Segment.
تحقق من أن أسماء الأحداث تتبع اصطلاحات التسمية في Segment.
تحقق من أن كل استدعاء يعيّن userId. يرفض Segment الاستدعاء الذي لا يحتوي على userId ولا anonymousId.
تحقق من حدود معدل HTTP API في Segment. يوصي Segment بالبقاء دون 1,000 طلب في الثانية لكل مساحة عمل.
إذا كانت مساحة العمل تستخدم منطقة Segment في الاتحاد الأوروبي، فأرسل الاستدعاءات إلى https://events.eu1.segmentapis.com/v1/track وhttps://events.eu1.segmentapis.com/v1/identify بدلًا من ذلك.

Transformation Errors

تحقق من أن الحمولة تطابق تنسيق API الخاص بـ Segment.
تحقق من وجود جميع الحقول المطلوبة. يتطلب Track الحقل event، ويتطلب كل من Track وIdentify وجود userId أو anonymousId.
تحقق من أن أسماء الأحداث عبارة عن سلاسل نصية وليست كائنات.

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

المقدمة

البدء

أمثلة على Transformation Code

تتبّع أحداث الدفع

تتبّع دورة حياة الاشتراك

تحديد خصائص العميل

نصائح

استكشاف الأخطاء وإصلاحها

​المقدمة

​البدء

​أمثلة على Transformation Code

​تتبّع أحداث الدفع

​تتبّع دورة حياة الاشتراك

​تحديد خصائص العميل

​نصائح

​استكشاف الأخطاء وإصلاحها

المقدمة

البدء

أمثلة على Transformation Code

تتبّع أحداث الدفع

تتبّع دورة حياة الاشتراك

تحديد خصائص العميل

نصائح

استكشاف الأخطاء وإصلاحها