راهنمای استفاده از API

نوشته‌شده توسط: ستاره محمدکمال

6 مارس 2022

امکان جدیدی که به تازگی به نیوزباکس اضافه شده است، امکان دسترسی به APIها است. شما می‌توانید با استفاده از APIهای نیوزباکس، تمام کارهایی که در پنل نیوزباکس انجام می‌دهید را در نرم‌افزار یا سایت خودتان انجام دهید. مثلا می‌توانید آخرین مطالب اینباکس را دریافت کرده، اینباکس‌های خود را ویرایش کنید یا اینباکس جدیدی بسازید و …

مستندات کامل تمامی APIها، در صفحه مستندات قابل مشاهده است. در این نوشته، قدم به قدم مراحل استفاده از APIها برای دریافت آخرین منشن‌های یک اینباکس را با هم طی می‌کنیم.

پیش از هر چیز، نیاز به دریافت token دسترسی دارید. برای گرفتن توکن، در پنل نیوزباکس وارد بخش تنظیمات، و سپس تب مخاطبان شوید. از بخش مخاطبان گزینه API را بزنید و روی دکمه ساخت توکن جدید بزنید.

توجه داشته باشید که بعد از زدن ساخت توکن، تنها یک‌بار توکن به شما نمایش داده می‌شود. همچنین باید در نگهداری از توکن کوشا باشید چرا که با استفاده از این توکن، افراد می‌توانند به همه امکانات پنل شما دسترسی داشته باشند.

ارسال این توکن برای ارسال ریکوست‌های بعدی ضروری است. در ارسال درخواست‌ها کافیست که در Header درخواست مقدار کلید Authorization را برابر با Bearer YOUR TOKEN قرار دهید.

برای مثال تصور کنید می‌خواهیم لیست تمامی پست‌های دریافتی در یک اینباکس (منشن‌های اینباکس) را بگیریم. مطابق مستندات گرفتن لیست منشن‌ها، باید یک درخواست GET به نشانی زیر ارسال کنیم:

/domains/{domain_id}/users/{user_id}/teams/{team_id}/inboxes/{inbox_id}/mentions

که در این نشانی، ‍مقادیر زیر باید جایگزین شوند:

• domain_id:
  • شناسه دامنه به شکل ثابت و برای همه درخواست‌ها مقدار ثابت (۶۴۱۲۹۹۹۸۵۴۱۲۹۱۵۲۰۶۶) است.
• user_id:
  • شناسه کاربری شماست. برای دریافت کاربری خودتان می‌توانید از درخواست /self استفاده کنید. کار دیگر این است که در مرورگر با استفاده از inspect مقدار شناسه کاربری خودتان پیدا کنید. برای نمونه
  • team_id:
    • شناسه تیم شماست. برای پیدا کردن شناسه تیم می‌توانید از روش‌های قبلی استفاده کنید.
  • inbox_id:
    • شناسه اینباکسی‌ است که می‌خواهید منشن‌های آن را دریافت کنید. برای دریافت شناسه می‌توانید از روش‌های مشابه بالا استفاده کنید یا وارد صفحه اینباکس شده و از نشانی url شناسه را دریافت کنید.
    • حال همه چیز تکمیل است و باید ریکوست را ارسال کنید. مثلا با استفاده از نرم‌افزار Postman این درخواست را بفرستید.همانطور که می‌بینید در پاسخ لیستی از منشن‌های اینباکس مورد نظر دریافت شده است.چیزی که دیدید، یک مثال ساده از گرفتن منشن‌های یک اینباکس بود. با مشاهده مستندات کامل apiهای نیوزباکس، کارهای بیشتری نیز انجام دهید. همچنین می‌توانید در پارامترهای ارسالی درخواست‌های APIها، مثل تعداد منشن‌های دریافتی در یک درخواست را تغییر دهید.

      در صورتی که فرایندی که می‌خواهید انجام دهید سوالی داشتید یا مشکلی بروز کرد با تیم پشتیبانی نیوزباکس تماس بگیرید. همکاران فنی ما می‌توانند شما را راهنمایی کنند.