کلید احراز هویت وب‌سرویس

تعریف کلید احراز هویت

برای ارسال اعلان نیاز به کلید احراز هویت می‌باشد که از کنسول پوشه می‌توان آن را دریافت کرد. در هنگام ارسال اعلان باید این کلید را در هدر ریکوئست و به عنوان مقدار Authorization به شکل زیر قرار داد.

Authorization: Token YOUR_AUTH_KEY

در کد بالا عبارت Token مقدار ثابتی است که باید حتما قبل از مقدار کلید احراز هویت (‍YOUR_AUTH_KEY) قرار گیرد.

نکته مهم

بین کلید Token و کلید YOUR_AUTH_KEY حتما باید به اندازه یک space فاصله وجود داشته باشد.

نکته

در ادامه راهنما هرجا از عبارت YOUR_AUTH_KEY استفاده شد منظور مقدار همین کلیدی است که در اینجا توضیح داده می‌شود.

نحوه دریافت کلید احراز هویت

  1. برای دریافت کلید احراز هویت به کنسول پوشه بروید سپس با وارد کردن ایمیل و رمزعبور خود به حساب خودتان وارد شوید.

  2. بر روی آیکن حساب کاربری در بالا و سمت چپ صفحه کلیک کنید و از منوی باز شده بر روی وب‌سرویس - api کلیک کنید.
    console web service

  3. در صفحه باز شده یک رشته ۴۰ کاراکتری قابل مشاهده می‌باشد که همان کلید احراز هویت شما می‌باشد. console get token

نحوه استفاده از کلید احراز هویت

برای استفاده از وب‌سرویس موبایل پوشه باید کلید احراز هویت خود را در هدر تمامی ریکوئست‌هایی که ارسال می‌کنید به شکل Authorization: Token YOUR_AUTH_KEY قرار دهید.

  • در این نمونه کد از cURL استفاده شده است که می‌توانیدتوسط sudo apt install curl آن را نصب کنید.
curl -X POST some url to call ... \
-H 'authorization: Token YOUR_AUTH_KEY' \
-H 'content-type: application/json' \
-d 'your data'