API و برنامه‌های توسعه‌دهندگان
کلید API بسازید، برنامهٔ OAuth ثبت کنید و به مستندات توسعه‌دهندگان بروید.
کنسول برای دو نوع یکپارچه‌سازی دو نوع اعتبار دارد:
- کلید API برای دسترسی مستقیم و محدود یک سرویس به عملیات Console و داده‌هاست.
- برنامهٔ توسعه‌دهندگان یک کلاینت OAuth ثبت می‌کند تا برنامهٔ دیگر بتواند کاربر را وارد کند و scopeهای لازم را بگیرد.
ساخت کلید API
۱. تنظیمات > کلیدهای API را باز کنید. ۲. کلید جدید را بزنید و نام وارد کنید. ۳. در صورت نیاز تاریخ انقضا بگذارید. ۴. فقط scopeهای موردنیاز یکپارچه‌سازی را انتخاب کنید. ۵. کلید را بسازید و همان لحظه کپی کنید.
کنسول secret را فقط یک‌بار نشان می‌دهد. آن را در secret manager یا متغیر محیطی نگه دارید و داخل bundle مرورگر، مخزن عمومی، داشبورد یا تصویر پشتیبانی قرار ندهید.
| scope | کاربرد |
|---|---|
devices:read و devices:write | خواندن یا مدیریت دستگاه‌ها |
templates:read و templates:write | خواندن یا مدیریت قالب و نگاشت‌ها |
datastreams:read، datastreams:write و datastreams:manage | خواندن مقدار، نوشتن مقدار یا مدیریت تعریف کانال |
provisioning:read و provisioning:write | خواندن یا صدور اطلاعات فعال‌سازی |
mqtt:manage | مدیریت اطلاعات اتصال MQTT دستگاه‌ها |
flovaql:read و telemetry:read | اجرای FlovaQL و خواندن تله‌متری |
وقتی یکپارچه‌سازی تمام شد، secret احتمالاً افشا شده است یا مالک آن عوض شده، کلید را از صفحهٔ کلیدهای API لغو کنید. برای چرخش بدون قطعی، ابتدا کلید جایگزین بسازید.
ثبت برنامهٔ OAuth
۱. تنظیمات > برنامه‌های توسعه‌دهندگان را باز کنید.
۲. نام برنامه را وارد کنید.
۳. محل اجرای برنامه را انتخاب کنید: سرور یا backend، مرورگر، یا موبایل و دسکتاپ.
۴. scopeهای مجاز را انتخاب کنید.
۵. برای برنامهٔ مرورگری، نشانی‌های بازگشت HTTPS را وارد کنید. localhost برای توسعه مجاز است.
۶. برای برنامهٔ native، scheme اختصاصی مثل my-app://oauth/callback وارد کنید.
۷. برنامه را بسازید و Client ID و هر Client Secret نمایش‌داده‌شده را ذخیره کنید.
برنامهٔ سرور callback نمی‌خواهد و Client Secret دارد. برنامهٔ مرورگری و native حداقل به یک نشانی بازگشت معتبر نیاز دارند. حذف برنامه tokenهای فعال آن را باطل می‌کند. با چرخش Client Secret، secret قبلی دیگر معتبر نیست.
برای یکپارچه‌سازی کاربرمحور از OAuth استفاده کنید. برای سرویس کنترل‌شده‌ای که از قبل workspace مشخص دارد و دسترسی مستقیم محدود می‌خواهد، کلید API مناسب است.
مستندات توسعه‌دهندگان
- مستندات API قرارداد HTTP و مثال‌ها را توضیح می‌دهد.
- FlovaQL در کنسول محیط اجرای کوئری تله‌متری است.
- FlovaAI در کنسول برای بررسی عملیات پشتیبانی‌شدهٔ داده و دستگاه در workspace فعال استفاده می‌شود.
- مخزن فریم‌ور فلووا SDK و بخش دستگاهی اتصال را توضیح می‌دهد.
اگر درخواست رد شد، نوع اعتبار، scope، workspace فعال و انقضا یا لغو شدن کلید و secret را بررسی کنید.