شروع کار
احراز هویت (Authentication)
راهنمای نحوه دریافت کلید دسترسی (API Key) و احراز هویت درخواستها.
برای ارسال درخواست به API فیدگاه و استفاده از قابلیتهای آن، باید تمامی درخواستها احراز هویت (Authenticate) شوند. این کار از طریق یک کلید اختصاصی به نام کلید دسترسی (API Key) انجام میشود.
دریافت کلید دسترسی (API Key)
برای ساخت و دریافت کلید خود، مراحل زیر را دنبال کنید:
- وارد داشبورد وبسایت شوید.
- به صفحه کلیدهای API بروید.
- یک کلید دسترسی جدید ایجاد کرده و آن را کپی کنید.
توجه
کلید دسترسی شما مانند رمز عبور است. آن را در اختیار دیگران قرار ندهید و هرگز در کدهای سمت کلاینت (Client-side) که برای همه قابل مشاهده است، استفاده نکنید.
نحوه استفاده در درخواستها
کلید دریافتی را در هدر (Header) تمام درخواستهای خود با کلید x-api-key ارسال کنید. در صورتی که این هدر ارسال نشود یا نامعتبر باشد، درخواست با خطای 401 Unauthorized مواجه خواهد شد.
نمونه درخواست (Example Request):
curl -X GET https://fidegah.ir/api/v1/boards \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"