سرویس مشتری

در صورتی که ارائه دهنده سرویس SaaS هستید یا مشتری در ازای پرداخت حق عضویت از خدمات شما استفاده می‌کند و می‌خواهید در طول یک مدت زمان خاص یا برای تکرار خرید به بازاریاب پورسانت پرداخت کنید. نیاز است از طریق APIهای ارائه شده در این صفحه مشتریانی که از طریق بازاریابهای افیلی در سیستم شما ثبت نام می‌کنند را در افیلی تعریف کنید.

تعاریف

مشتری:

کاربری که برای استفاده از خدمات در سایت یا اپلیکیشن شما ثبت نام کرده است.

پیش‌نیازها

برای استفاده از سرویس‌های تعریف شده، نیاز به ارسال Bearer توکن است. از طریق ارتباط با پشتیبانی می‌توانید توکن دسترسی را دریافت کنید.

آدرس پایه ارسال درخواست‌ها

https://core.affili.ir/services/customers

API مشتری‌ها

طبق توضیحات داده شده در جدول زیر، از سه API تعریف شده می‌توانید برای ایجاد، ویرایش و دریافت مشتری‌ها استفاده کنید.

نوع عملیات	نوع درخواست	توضیحات	uri
ایجاد	POST	ایجاد مشتری جدید
ویرایش	POST	ویرایش مشتری ایجاد شده؛ customerId شناسه مشتری ایجاد شده در افیلی است.	/{customerId}
لیست	GET	دریافت لیست مشتری‌های ثبت شده

ایجاد مشتری

بعد از اینکه کاربر از طریق لینک افیلیت وارد وبسایت شما شد پارامتر referrer را به مدت زمان طول دوره کوکی (مقدار پارامتر exp)، در کوکی مرورگر وی ذخیره می‌کنیم.

بعد از ثبت نام کاربر، از طریق API مربوط به ایجاد مشتری اطلاعات مربوطه به افیلی ارسال می‌شود. همچنین دقت داشته باشید که مقدار شناسه مشتری در افیلی باید توسط شما ذخیره گردد تا در زمان ثبت کانورژن بتوانید از آن استفاده کنید. در ادامه به بررسی نمونه دیتای ارسالی و دریافتی در ایجاد مشتری خواهیم پرداخت.

آدرس ارسال درخواست

POST https://core.affili.ir/services/customers

قالب درخواست ایجاد مشتری

{
  "referrer": string,
  "mcs_id": string,
  "is_new": boolean,
  "meta_data": object (MetaData)
}

پارامترها

نام	اجباری	توضیحات
referrer	بلی	String توکن ارجاع که قبلا در مرورگر کاربر ذخیر شده.
mcs_id	بلی	String شناسه یکتای مشتری در سیستم شما
is_new	خیر	Boolean پارامتر مشخص کننده مشتری جدید، در صورتی که مشتری جدید باشد مقدار true باید ارسال شود.
meta_data	خیر	MetaData Object آبجکت حاوی اطلاعات اضافه راجع به مشتری

قالب پاسخ ایجاد مشتری

{
  "status": "ok",
  "tag": "saveCustomer",
  "api_version": "1.0.0",
  "data": {
    "id": string,
    "mcs_id": string,
    "is_new": boolean,
    "meta_data": object (MetaData)
    "created_at": dateTime,
    "updated_at": dateTime,
    "publisher": object (Publisher)
  }
}

پارامترها

نام	توضیحات
id	String شناسه یکتای مشتری ایجاد شده در افیلی
mcs_id	String شناسه مشتری در سیستم شما
is_new	Boolean پارامتر مشخص کننده مشتری جدید
meta_data	MetaData Object آبجکت حاوی اطلاعات اضافه راجع به مشتری
publisher	Publisher Object آبجکت حاوی اطلاعات بازاریاب
created_at	DateTime تاریخ ایجاد
updated_at	DateTime تاریخ آخرین بروزرسانی

ویرایش مشتری

برای تغییر در اطلاعات مشتری می‌توانید از API زیر استفاده کنید.

POST https://core.affili.ir/services/customers/{customerId}

*پارامتر customerId در آدرس، شناسه مشتری ثبت شده در افیلی است.

قالب درخواست ویرایش مشتری

{
  "mcs_id": string,
  "meta_data": object (MetaData)
}

لیست مشتری‌ها

برای دریافت لیست مشتری‌های ثبت شده از API زیر استفاده کنید.

آدرس ارسال درخواست

GET https://core.affili.ir/services/customers

قالب پارامترهای ارسالی برای اعمال فیلتر

{
  "id": string,
  "mcs_id" string,
  "min_created_at": dateTime,
  "max_created_at": dateTime,
  "min_updated_at": dateTime,
  "max_updated_at": dateTime,
  "publisher_id": integer
}

موجودیت‌ها

Meta Data

قالب JSON

{
  "first_name": string,
  "last_name": string,
  "mobile": string,
  "email": string
  
  // Any other fields can be added as extra data.
}

Publisher

قالب JSON

{
  "id": string,
  "full_name": string
}