آموزش API ارسال فرم

معرفی API

این API برای دریافت اطلاعات فرم و نمایش یا ثبت آن در فرم‌ساز آریا CRM استفاده می‌شود. درخواست باید به صورت POST ارسال شود.

آدرس API

پارامترهای اجباری

برای پردازش درخواست، ارسال سه پارامتر زیر الزامی است:

پارامتر	اجباری	توضیح	نمونه
key	بله	کلید امنیتی API	FhkghyhfyFhj753$degH
userid	بله	شناسه کاربری که درخواست به او اختصاص داده می‌شود.	12
formid	بله	شناسه فرمی که اطلاعات باید برای آن ارسال شود.	2

پارامترهای اختیاری

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

مثلا اگر فرم شما مخاطب هست که شناسه آن 2 هست
نکته: شناسه فرم ها را میتوانید از لیست فرم های ساخته شده در فرم های سفارشی ببینید
فیلد هایی مثل موبایل - نام - ایمیل - فکس دارد که وقتی به ویرایش فیلد این بخش مراجعه کنید میتوانید نامک این فیلد ها را مشاهده کنید که به صورت عکس زیر میباشد.

در تصویر بالا نامک های name,tell,mobile,tells هست که شما میتوانید آنها را نیز ارسال کنید که میشود :

$data = [
    'key'     => 'YOUR_API_KEY',
    'userid'  => 12,
    'formid'  => 2,

    // فیلدهای فرم
    'name'    => 'Ali Ahmadi',
    'mobile'  => '09121234567',
	'tell'   => '0313393916',
    'tells'   => ''
	
];

پارامتر	وضعیت	توضیح	نمونه
mobile	اختیاری	شماره موبایل مخاطب. در فرم شماره 2 در منطق انتخاب کاربر نیز بررسی می‌شود.	09121234567
سایر فیلدهای فرم	اختیاری / وابسته به فرم	هر فیلدی که فرم مقصد نیاز دارد می‌تواند همراه POST ارسال شود.	name=Ali

نمونه ارسال درخواست با PHP

$data = [
    'key'     => 'YOUR_API_KEY',
    'userid'  => 12,
    'formid'  => 2,

    // فیلدهای فرم
    'name'    => 'Ali Ahmadi',
    'mobile'  => '09121234567',
    'email'   => 'ali@example.com'
];

$ch = curl_init('https://YOUR-DOMAIN/api.php');

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

نمونه درخواست HTML Form

<form action="https://YOUR-DOMAIN/api.php" method="post">

    <input type="hidden" name="key" value="YOUR_API_KEY">
    <input type="hidden" name="userid" value="12">
    <input type="hidden" name="formid" value="2">

    <input type="text" name="name" placeholder="نام">
    <input type="text" name="mobile" placeholder="موبایل">
    <input type="email" name="email" placeholder="ایمیل">

    <button type="submit">ارسال</button>

</form>

پاسخ API

در صورت معتبر بودن کلید امنیتی و پردازش موفق درخواست، API در انتها مقدار ok را برمی‌گرداند.

ok

اگر کلید امنیتی صحیح نباشد، پیام خطای مربوط به نامعتبر بودن کلید نمایش داده می‌شود.

کلید امنیتی نامعتبر است.

نکات مهم

• نوع درخواست باید POST باشد.
• پارامترهای key، userid و formid برای پردازش درخواست ضروری هستند.
• نام سایر پارامترها باید با نام فیلدهای فرم مقصد مطابقت داشته باشد.
• کلید امنیتی را در کدهای عمومی یا صفحات قابل مشاهده برای کاربران منتشر نکنید.
• در صورت استفاده از فرم شماره 2، ارسال mobile می‌تواند در منطق انتخاب کاربر مؤثر باشد.

ساختار کلی درخواست

POST /api.php

key=YOUR_API_KEY
userid=12
formid=2

name=Ali Ahmadi
mobile=09121234567
email=ali@example.com

تکمیل مستندات

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