راهنمای اتصال به API

مقدمه:

این وب سرویس به شما امکان می‌دهد درخواست‌های ایندکس (Index) را به صورت خودکار به Google Indexing API ارسال کنید. با استفاده از این مستند، می‌توانید به درستی از این وب سرویس استفاده کنید.

۱. احراز هویت (Authentication):

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

Authorization: Bearer YOUR_API_TOKEN

۲. ساختار درخواست (Request Structure):

نوع درخواست: POST
آدرس درخواست:

https://indexapi.ir/api/

هدرهای مورد نیاز:

توضیحات	مقدار	هدر
فرمت داده‌ها	application/json	Content-Type
توکن احراز هویت	Bearer YOUR_API_TOKEN	Authorization

بدنه درخواست (Request Body):

{
    "url": "https://example.com/sample-page",
    "action": "update"
}

فیلدهای موجود:

فیلد	نوع	مقدارهای مجاز	توضیحات
url	string	لینک کامل صفحه	لینک صفحه
action	string	update, delete	نوع عملیات: update برای بروزرسانی و delete برای حذف لینک

۳. پاسخ API (Response):

پاسخ موفقیت‌آمیز:

{
    "result": "success",
    "type": "URL_UPDATED",
    "body": {
        "urlNotificationMetadata": {
            "url": "https://example.com/sample-page"
        }
    }
}

پاسخ خطا:

{
    "result": "error",
    "message": "Invalid API Key"
}

۴. کدهای خطای رایج:

نکات مهم:

• احراز هویت: بدون ارسال توکن معتبر، درخواست‌ها رد می‌شوند.
• فرمت صحیح لینک‌ها: لینک‌ها باید کامل و با پروتکل https:// باشند.
• ثبت پروژه: قبل از استفاده، حتماً پروژه خود را در پنل مدیریت ثبت کنید.