معرفی: وب هوک های مشتری برای PhotoRobot Cloud

وب هوک های مشتری برای PhotoRobot Cloud

توسعه دهندگان و تیم های فناوری اطلاعات شما اکنون می توانند PhotoRobot Cloud را با وب هوک های خروجی امضا شده به DAM، PIM، ERP یا اتوماسیون سفارشی شما متصل کنند. وب هوک های مشتری در PhotoRobot Cloud ارائه داده های قابل اعتماد و مبتنی بر رویداد را ارائه می دهند – که اتصال کامل بین استودیو و سیستم ها را تضمین می کند.

‍

‍

‍

حلقه بین استودیو و سیستم ها را ببندید

اطمینان حاصل کنید که سیستم های پایین دستی شما می دانند که وضعیت یک کالا تغییر می کند یا رویداد در دسترس بودن میزبانی رخ می دهد. PhotoRobot Cloud Webhooks هر رویداد را به نقاط پایانی شما تحویل می دهد تا ادغام ها مبتنی بر رویداد باقی بمانند – نه مبتنی بر نظرسنجی.

رویدادهای زنده عبارتند از:

• item.status.changed – تغییر وضعیت گرفتن روی یک آیتم انجام می شود.
• item.status.bulk_changed — یک رویداد پس از تغییر وضعیت عمده در فضای ابری.
• hosting.item.availability.changed — رسانه های میزبانی شده قابل دانلود یا غیرقابل دسترس شدند.
• webhook.subscription.test — فقط ارسال تست.

‍

‍

‍

تحویل داده های قابل اعتماد و مبتنی بر رویداد

وب هوک های مشتری در PhotoRobot Cloud شامل ویژگی هایی برای موارد زیر هستند:

• اشتراک های وب هوک خروجی که همراه با ادغام توسعه دهندگان شما مدیریت می شوند.
• تحویل HTTP امضا شده تا گیرندگان بتوانند اصالت را تأیید کنند.
• «ارسال آزمایش» و فیلترها برای تأیید اشتراک webhook و تأیید امضا.
• گزارش تحویل برای بررسی بار، وضعیت HTTP و بازیابی ها.
• رابط کاربری توسعه دهندگان تحت وب هوک ها — وب هوک ها و تحویل ها در کنار کلیدهای API قرار دارند.

‍

‍

‍

صحبت کردن به زبان خود برای ادغام های تولید

Webhookهای مشتری حلقه گمشده بین ضبط رباتیک و سیستم های ثبت شرکت هستند. Webhook یک سیگنال امضا شده است که عمدا فقط محموله های کوچک را حمل می کند. پس از 2xx، یکپارچه سازی آیتم فعلی را از REST v2 (pull.itemUrl / pull.deltaUrl) می کشد. Webhooks می تواند به ناشر اطلاع دهد یا پس از کشیدن، به تیم شما در شروع پاکسازی CDN یا به روزرسانی فهرست بازار کمک کند. PhotoRobot Cloud اکنون زبان شما را برای یکپارچه سازی های تولید می گوید.

‍

‍

‍

یک سیگنال، سپس یک کشیدن

محموله ها عمدا کوچک باقی می مانند. هر محموله رویداد، سازمان و (در صورت لزوم) آیتم را نام گذاری می کند، به علاوه pull.itemUrl و pull.deltaUrl. محموله ها باینری های تصویر، درخت پوشه کامل یا رکورد کامل محصول را حمل نمی کنند.

الگویی که توسعه دهندگان باید پیاده سازی کنند عبارت است از:

1. POST را دریافت کنید و X-PhotoRobot-Signature را در برابر بدن خام بررسی کنید.
2. 2xx را سریع برگردانید — وارد کردن DAM یا به روزرسانی بازار را در کارمند خودتان انجام دهید.
3. حذف تکراری بر اساس شناسه رویداد. تحویل حداقل یک بار انجام می شود.
4. وضعیت فعلی را از میزبانی REST v2 با استفاده از URLهای کششی دریافت کنید.

این تقسیم بندی است که ادغام را قابل اعتماد می کند. PhotoRobot منتظر نمی ماند تا کار کاتالوگ شما تمام شود و سیستم شما هرگز اعلان را به عنوان کاتالوگ در نظر نمی گیرد.

‍

‍

‍

نمونه های رایج استفاده از وب هوک های مشتری

رایج ترین موارد استفاده از Web hookهای مشتری در اکوسیستم PhotoRobot عبارتند از:

• به روزرسانی PIM یا DAM. اشتراک hosting.item.availability.changed. وقتی رسانه میزبانی شده قابل دانلود شد، itemURL را بردارید و محصول — چرخش ها، عکس های ثابت و متادیتا — را در یک مرحله به روزرسانی کنید.
• فهرست بازار. رویدادهای میزبانی را به «قابل دانلود شد» فیلتر کنید. فهرست را فقط پس از اینکه PhotoRobot واقعا بتواند تصاویر را نمایش دهد، منتشر یا به روزرسانی کنید.
• دیده شدن در برد تولید. وقتی هیئت ERP یا QC شما نیاز دارد بداند که آیتم به حالت ویرایش شده، تأیید شده یا منتشر شده — حتی قبل از آماده شدن میزبانی، عضو item.status.changed شوید.
• به روزرسانی های گسترده کمپین. پس از تغییر وضعیت بزرگ در Cloud، یک رویداد item.status.bulk_changed با یک deltaUrl می آید. به جای انتظار هزاران webhook به ازای هر آیتم، مجموعه آسیب دیده را دنبال کنید.
• نامعتبر شدن کش یا CDN. وقتی میزبانی به حالت موجود یا غیرقابل دسترس تغییر می کند، مسیرهایی را که فروشگاه شما از قبل می شناسد پاک یا گرم کنید. وب هوک محرک است؛ API میزبانی منبع URLهای جدید است.

‍

‍

‍

چگونه وب هوک های مشتری خود را پیکربندی کنیم

برای راه اندازی Customer Webhooks برای PhotoRobot Cloud، حساب PhotoRobot خود را در حالت توسعه دهندگان باز کنید و با استفاده از Webhooks اشتراک webhook بسازید. سپس اشتراک را به نقطه پایانی مرحله بندی خود هدایت کنید تا اولین تحویل را تأیید کنید.

‍

‍

1. وارد حساب PhotoRobot شوید و توسعه دهندگان را → وب هوکس باز کنید.
2. یک webhook بسازید. نقطه پایانی HTTPS خود را جای گذاری کنید، یک نام داخلی برایش بگذارید و رویدادهایی که نیاز دارید را انتخاب کنید.
3. وقتی راز امضا ظاهر شد، آن را کپی کنید — یک بار نمایش داده می شود تا زمانی که آن را بچرخانید.
4. روی ارسال تست کلیک کنید. تأیید کنید webhook.subscription.test می رسد و امضا تأیید می شود.
5. لاگ تحویل را باز کنید تا بار، وضعیت HTTP و بازبینی ها را بررسی کنید.
6. اولین اشتراک را به یک نقطه پایانی مرحله بندی هدایت کنید.

‍

‍

برای اطلاعات فنی بیشتر از جمله قراردادهای توسعه دهنده و نمونه های امضا، به PhotoRobot Developer Portal – Webhooks مراجعه کنید.

‍

‍