بررسی
رصد فقط یک ابزار پایش است که در مرورگر باز می‌شود. کنار آن، یک پلتفرم توسعه‌دهنده هم هست: سرویس‌هایی که با یک کلید API فراخوانی می‌کنید و داده‌شان را مستقیم در برنامهٔ خودتان می‌گذارید.
این بخش راهنمای استفاده از آن سرویس‌هاست. اگر تا امروز فقط از پنل پایش استفاده کرده‌اید، اینجا چیزی برای کار با پنل ندارید؛ این بخش مخصوص برنامه‌نویسی است.
چه چیزی در این پلتفرم هست
| سرویس | چه می‌دهد | راهنما |
|---|---|---|
| سرویس نتایج گوگل | نتایج جستجوی گوگل برای دامنه و کلمهٔ کلیدی، یک‌باره یا روی زمان‌بندی | سرویس نتایج گوگل |
چرا این جدا از پایش است
پایش و API دو کار متفاوت‌اند: پایش در مرورگر و به‌صورت خودکار، و API در کد خودتان و با کنترل کامل.
| موضوع | کنسول پایش | پلتفرم توسعه‌دهنده |
|---|---|---|
| مخاطب | مدیر محصول، سئوکار | برنامه‌نویس |
| ورود | شمارهٔ موبایل | کلید API |
| خروجی | صفحه و نمودار | JSON |
| زمان‌بندی | خودکار روی سایت‌های شما | خودتان تعیین می‌کنید |
| سقف | پلن سازمان | محدودیت نرخ |
| مقصد این راهنما | همان پنل | همین بخش |
چه چیزی با این سرویس می‌توانید بسازید
- رهگیری رتبهٔ چند دامنه روی زمان‌بندی دلخواه، مستقل از پنل پایش
- صفحهٔ تاریخچهٔ رتبه برای مشتریان خودتان، با دادهٔ خودتان
- تشخیص جابه‌جایی رتبه و ارسال هشدار در سامانهٔ داخلی خودتان
- گزارش‌گیری دوره‌ای از وضعیت دیده‌شدن یک مجموعه دامنه
- داشبورد تحقیق کلمهٔ کلیدی، بدون ساختن زیرساخت جمع‌آوری داده
شروع کنید
مسیر پیشنهادی سه قدم است:
کلید بگیرید
کلید API از طریق پشتیبانی صادر می‌شود، نه در پنل رصد. کلید فقط یک بار هنگام ساخت نشان داده می‌شود و پس از آن فقط هش SHA-256 آن نگه داشته می‌شود. اگر آن را گم کنید باید کلید تازه صادر شود.
سقف‌های کلیدتان را بپرسید
اولین درخواستتان باید این باشد:
curl -s -H "X-API-Key: $KEY" \
https://serp.rasaad.ir/api/v1/operator/capabilities
این اندپوینت فقط یک کلید معتبر می‌خواهد و هیچ دسترسی خاصی لازم ندارد، چون تا وقتی نفهمیده‌اید چه کارهایی برایتان مجاز است، نمی‌توانید بپرسید. جزئیات در احراز هویت آمده است.
یک پرس‌وجوی یک‌باره بفرستید
curl -s -X POST -H "X-API-Key: $KEY" -H 'Content-Type: application/json' \
-d '{"domain":"example.ir","keyword":"shoes","city":"tehran"}' \
https://serp.rasaad.ir/api/v1/operator/queries
این یک خزش را همین حالا اجرا می‌کند، هیچ زمان‌بندی‌ای نمی‌سازد و هیچ اثر جانبی ندارد. برای آشنایی، همین کافی است. برای اینکه بدانید چطور تا آماده‌شدن نتیجه صبر کنید، پرس‌وجوها را ببینید.
X-API-Key یک اعتبار است، نه یک شناسهٔ عمومی. آن را در متغیر
محیطی (env) نگه دارید و هرگز داخل ریپوی گیت نگذارید.نقشهٔ این راهنما
| صفحه | موضوع |
|---|---|
| سرویس نتایج گوگل | سرویس چیست، دسته اندپوینت، و شروع سریع |
| احراز هویت | کلید API، دسترسی‌ها، مالکیت داده و سه نوع خطای دسترسی |
| اهداف | رهگیری یک پرس‌وجو روی زمان‌بندی؛ ساخت، ویرایش، خاموش‌کردن و تاریخچه |
| پرس‌وجوها | اجرای یک‌باره و مدل وضعیت آن |
| نتایج | سند نتیجه، قالب SerpAPI، نمایش markdown و HTML خام |
| مصرف | شمارش پرس‌وجوها، اجراها و هدف‌ها در یک دوره |
| محدودیت نرخ | سطل توکن و هدرهای آن |
| صفحه‌بندی | پیمایش با کرسر امضاشده |
| مرجع خطاها | فهرست کامل کدهای وضعیت و معنای هرکدام |
| مسیرهای قدیمی | /api/* و تفاوت‌هایش با API منابع |