ایجاد پیوندهای پویا با REST API

می‌توانید با Firebase Dynamic Links REST API، Dynamic Links کوتاه ایجاد کنید. این میانای برنامه‌سازی کاربردی یک Dynamic Link طولانی یا شیء حاوی پارامترهای Dynamic Link را می‌پذیرد و نشانی وبی مانند مثال زیر برمی‌گرداند:

https://example.page.link/WXYZ

Dynamic Links کوتاه ایجادشده با میانای برنامه‌سازی کاربردی و کیت توسعه نرم‌افزار (Android/Apple) مشتری در کنسول Firebase نشان داده نمی‌شود. این Dynamic Links برای هم‌رسانی کاربر با کاربر درنظر گرفته شده است. برای موارد استفاده بازاریابی، همچنان پیوندهایتان را مستقیماً ازطریق صفحه Dynamic Links کنسول Firebase ایجاد کنید.

قبل از شروع

  1. کلید میانای برنامه‌سازی کاربردی خود را دریافت کنید. برای اصالت‌سنجی درخواست‌هایتان به میانای برنامه‌سازی کاربردی، به کلید میانای برنامه‌سازی کاربردی نیاز دارید. برای پیدا کردن کلید میانای برنامه‌سازی کاربردی:
    1. صفحه تنظیمات کنسول Firebase را باز کنید. اگر از شما خواسته شد پروژه‌ای را انتخاب کنید، پروژه Firebase خود را از منو انتخاب کنید.
    2. مقدار فیلد کلید میانای برنامه‌سازی کاربردی وب را یادداشت کنید.
  2. در کنسول Firebase، بخش Dynamic Links را باز کنید.

  3. اگر قبلاً شرایط خدمات را نپذیرفته‌اید و دامنه‌ای برای Dynamic Links خود تنظیم نکرده‌اید، وقتی از شما خواسته شد این کار را انجام دهید.

    اگر ازقبل دامنه Dynamic Links دارید، آن را یادداشت کنید. وقتی به‌طور برنامه‌نویسی‌شده Dynamic Links ایجاد می‌کنید، باید دامنه Dynamic Links ارائه دهید.

می‌توانید از Firebase Dynamic Links API برای کوتاه کردن Dynamic Link طولانی استفاده کنید. برای انجام این کار، یک درخواست HTTP POST به نقطه پایانی shortLinks ارسال کنید و Dynamic Link طولانی را در پارامتر longDynamicLink مشخص کنید. برای مثال:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

برای آشنایی با نحوه ایجاد Dynamic Links طولانی، به ساختن دستی نشانی وب مراجعه کنید.

همچنین می‌توانید با مشخص کردن مستقیم پارامترهای Dynamic Link، Dynamic Link کوتاهی ایجاد کنید. برای انجام این کار، یک درخواست HTTP POST به نقطه پایانی shortLinks ارسال کنید و پارامترهای Dynamic Link را در پارامتر dynamicLinkInfo مشخص کنید. برای مثال:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

برای مشخصات کامل شیء dynamicLinkInfo، به مرجع میانای برنامه‌سازی کاربردی مراجعه کنید.

تنظیم طول یک فیلم کوتاه Dynamic Link

همچنین می‌توانید پارامتر suffix را تنظیم کنید تا مشخص کنید مؤلفه مسیر Dynamic Link کوتاه چگونه تولید می‌شود.

به‌طور پیش‌فرض، یا اگر پارامتر را روی "UNGUESSABLE" تنظیم کنید، مؤلفه مسیر یک رشته ۱۷ نویسه‌ای خواهد بود، مانند مثال زیر:

https://example.page.link/UVWXYZuvwxyz12345

این رشته‌ها با کدگذاری base62 اعداد ۹۶ بیتی تولیدشده به‌صورت تصادفی ایجاد می‌شوند. از این تنظیم استفاده کنید تا از حدس زدن و خزیدن نشانی‌های وب Dynamic Links شما جلوگیری شود، که می‌تواند به‌طور بالقوه اطلاعات حساس را درمعرض دید گیرندگان ناخواسته قرار دهد.

اگر پارامتر را روی "SHORT" تنظیم کنید، مؤلفه مسیر رشته‌ای خواهد بود که فقط تا جایی که لازم است منحصربه‌فرد باشد طولانی است و حداقل طول آن ۴ نویسه است.

https://example.page.link/WXYZ

اگر اطلاعات حساس درصورت حدس زدن نشانی وب کوتاه Dynamic Link فاش نمی‌شود، از این روش استفاده کنید.

مثال زیر نشان می‌دهد که چگونه می‌توانید پارامتر suffix را تنظیم کنید:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

حداقل، مقدار پیوند عمیق ارائه‌شده باید با طرح‌های http:// ‎ یا https:// ‎ شروع شود. همچنین باید با هر الگوی نشانی وب فهرست مجاز واردشده در کنسول مطابقت داشته باشد. درغیراین‌صورت، میانای برنامه‌سازی کاربردی ایجاد با کد خطای HTTP 400 ناموفق خواهد بود.

مراحل بعدی

اکنون که Dynamic Links را ایجاد کرده‌اید، باید برنامه‌تان را برای دریافت Dynamic Links و هدایت کاربران به مکان درست در برنامه‌تان پس‌از باز کردن آن‌ها راه‌اندازی کنید.

برای دریافت Dynamic Links در برنامه‌تان، به اسناد مربوط به iOS،‏ Android، C++، و Unity مراجعه کنید.

درخواست‌ها به ۵ درخواست/نشانی IP/ثانیه و ۲۰۰٬۰۰۰ درخواست/روز محدود است. اگر از این حد فراتر رود، پاسخ کد خطای HTTP‏ ۴۲۹ را برمی‌گرداند.