به‌طور خلاصه: آژانس یک بار با نام حقوقی خود ثبتنام می‌کند. سپس با وارد کردن نام هر مشتری در نام نمایشی، برای مشتریانش تبلیغ می‌کند. آژانس پرداخت می‌کند، موجودی‌ها را نگه می‌دارد و صورتحسابها را دریافت می‌کند. توسعه‌دهندگان می‌توانند پیشنهادها و رویدادها را از طریق REST API Agilis (https://ads.agilis.dating) بسازند و مدیریت کنند. برای این کار به کلیدهای API از سامانهٔ تبلیغات نیاز دارند. کلیدهای آزمایشی رایگان‌اند و آنچه با آنها ساخته شود هرگز به اعضا نمایش داده نمیشود.
برای آژانس‌ها
- آژانس را ثبتنام کنید؛ با نام حقوقی خود آژانس. ← نحوهٔ ثبتنام
- هنگام ساخت پیشنهاد یا رویداد، نام مشتری خود را در نام نمایشی وارد کنید. اعضا نام مشتری را می‌بینند، نه نام شما را.
- برای تبلیغ از طرف هر مشتری باید از او مجوز داشته باشید. طبق شرایط تبلیغات، مسئولیت این موضوع با آژانس است.
چه کسی پرداخت می‌کند و صورتحساب به نام چه کسی صادر می‌شود
- پرداخت از حساب آژانس شما و با ارز صورتحساب آژانس انجام می‌شود.
- هر فرد در آژانس شما موجودی خود را دارد و از همان پرداخت می‌کند. موجودی سازمان مجموع این موجودی‌هاست. ← موجودی‌ها چگونه کار می‌کنند
- صورتحسابها و نتایج به نام آژانس شما صادر میشوند. برای هر پرداخت یک صورتحساب صادر می‌شود تا بتوانید هزینه را از هر مشتری مطالبه کنید.
- برای جدا نگه داشتن هزینه‌های هر مشتری، برای هر مشتری یک پیشنهاد یا رویداد جداگانه بسازید. سپس بر اساس صورتحساب آن، هزینه را از مشتری مطالبه کنید.
نقش‌های تیم
مدیران سازمان و تبلیغ‌کنندگان در سامانهٔ تبلیغات کار می‌کنند و توسعه‌دهندگان از طریق API. توسعه‌دهندگان نمی‌توانند در سامانهٔ تبلیغات پیشنهاد یا رویداد بسازند. اما با کلیدهای API خود می‌توانند از طریق API آنها را بسازند، منتشر کنند و هزینه‌شان را بپردازند. مسئولیت نحوهٔ استفاده از کلیدها با کسب‌وکار شماست. جدول کامل در نقش‌ها و دسترسی‌های تیم آمده است.
REST API Agilis
- نشانی پایه: https://ads.agilis.dating
- مرجع: www.agilis.dating/api-doc، با نمونه‌کدهایی به زبان‌های cURL، Python، Node.js و PHP و یک دستیار API
- قابل‌خواندن برای ماشین: OpenAPI 3.1 در www.agilis.dating/openapi.json، نسخهٔ Markdown در www.agilis.dating/api-doc.md و متن کامل برای ابزارهای هوش مصنوعی در www.agilis.dating/llms-full.txt
- پیشنهادها: دیدن فهرست دسته‌های شما و علاقه‌مندی‌ها؛ برآورد قیمت پیشنهاد پیش از ساخت آن؛ ساخت، فهرست کردن، توقف، ازسرگیری و حذف پیشنهادها؛ خواندن نتایج هر پیشنهاد
- رویدادها: پیش‌نمایش، انتشار، فهرست کردن، ویرایش، تغییر زمان، لغو و حذف رویدادها؛ خواندن نتایج هر رویداد
دریافت کلید API
- به‌عنوان مدیر سازمان یا توسعه‌دهنده وارد سامانهٔ تبلیغات شوید.
- با دکمهٔ تغییر حالت در بالای صفحه، حالت آزمایشی یا حالت واقعی را انتخاب کنید.
- به کلیدهای API ← ساخت کلید جدید بروید، برای کلید نامی بگذارید و در صورت تمایل تاریخ انقضا تعیین کنید.
- کلید را فوراً کپی کنید. پس از این دیگر نمی‌توانید آن را ببینید.
کلیدهای آزمایشی با pk_test_ و کلیدهای واقعی با pk_live_ شروع میشوند. هر فرد در هر حالت میتواند حداکثر ۱۰ کلید داشته باشد. تعویض کلید کلید را بلافاصله جایگزین می‌کند؛ پس ابتدا سامانه‌های خود را به‌روز کنید. کلید را در سرآیند درخواست x-api-key بفرستید: x-api-key: pk_test_….
توسعهٔ ایمن
- با کلید
pk_test_توسعه دهید و آزمایش کنید: پیشنهادها و رویدادهای آزمایشی رایگان‌اند و هرگز به اعضا نمایش داده نمی‌شوند. - پیش از ساخت پیشنهاد، قیمت آن را با endpoint برآورد قیمت محاسبه کنید.
- کلیدها را از مخزن‌های کد و مرورگرها دور نگه دارید و API را از سرور خود فراخوانی کنید.
پرسش‌ها
آیا یک آژانس میتواند چند مشتری را از یک حساب مدیریت کند؟
بله. آژانس را یک بار ثبتنام کنید و نام مشتری را روی هر پیشنهاد یا رویداد وارد کنید.
آیا هر مشتری میتواند صورتحساب جداگانه داشته باشد؟
صورتحسابها به نام آژانس شما صادر میشوند؛ برای هر پرداخت یک صورتحساب. بر اساس آنها هزینه را از مشتریان خود مطالبه کنید.
آیا محیط آزمایشی (sandbox) وجود دارد؟
بله. حالت آزمایشی با کلیدهای pk_test_ یک محیط آزمایشی کامل است. هیچ هزینهای کسر نمیشود و چیزی به اعضا نمایش داده نمیشود.
آیا می‌توانم ابزارهای برنامه‌نویسی هوش مصنوعی را متصل کنم؟
بله. ابزار خود را به www.agilis.dating/api-doc.md یا www.agilis.dating/openapi.json ارجاع دهید.
