help-header

چگونه API Key یا کلید دسترسی برنامه‌نویسی بسازید؟

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

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

mceclip0.png

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

mceclip0.png

پس از کلیک روی گزینه‌ی «کلید جدید»، با صفحه‌ی زیر رو‌به‌رو می‌شوید که می‌توانید یک نام برای API Key خود بگذارید:

mceclip2.png

پس از تایید، کلید شما ساخته می‌شود:

mceclip3.png

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

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

mceclip4.png

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

شما با استفاده از این کلید که ساختار آن به‌شکل زیر است، می‌توانید با قرار دادن کلید در بخش HEADER درخواست‌های خود در هدر Authorization، از APIهای ابر آروان به‌راحتی استفاده کنید:

Apikey XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

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