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

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

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

Authorization: Token YOUR_AUTH_KEY

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

نکته مهم

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

نکته

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

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

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

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

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

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

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

CURL

• در این نمونه کد از 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'

NODE.JS

• در این نمونه کد از پکیج axios استفاده شده که می توانید توسط npm i axios آن را نصب کنید.
• در این مثال فقط قسمتی از کد که برای احراز هویت می باشد نمایش داده شده و برای ارسال اعلان نیاز به کامل کردن این کد می‌باشد که در قسمت های دیگر راهنما توضیح داده خواهد شد

const axios = require('axios');

const YOUR_AUTH_KEY = 'put your auth key here ...';

const url = 'some endpoint to call ...';

const options = {
    headers: {
        'Authorization': Token YOUR_AUTH_KEY,
        'Content-Type': 'application/json'
    }
}

const data = {} // Some data to post 

axios.post(url, data, options);

PYTHON

• در این نمونه از پکیج requests استفاده شده که می‌توانید توسط دستور pip install requests آن را نصب کنید.
• در این مثال فقط قسمتی از کد که برای احراز هویت می باشد نمایش داده شده و برای ارسال اعلان نیاز به کامل کردن این کد می‌باشد که در قسمت های دیگر راهنما توضیح داده خواهد شد

import requests

YOUR_AUTH_KEY = 'put your auth key here ...'
YOUR_APP_ID = 'put your app id here ...'

url = 'some endpoint to call ...'

headers = {
    'Authorization': f'Token {YOUR_AUTH_KEY}',
    'Content-Type': 'application/json'
}

data = {} // some data to post

r = requests.post(url, data=data, headers=headers)

PHP

• در این مثال فقط قسمتی از کد که برای احراز هویت می باشد نمایش داده شده و برای ارسال اعلان نیاز به کامل کردن این کد می‌باشد که در قسمت های دیگر راهنما توضیح داده خواهد شد

$YOUR_AUTH_KEY = 'put your auth key here ...';

$url = 'some endpoint to call ...';

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_HTTPHEADER, 
    array(
        "Content-Type: application/json", 
        "Authorization: Token " . $YOUR_AUTH_KEY
    ),
);

GO

• در این مثال فقط قسمتی از کد که برای احراز هویت می باشد نمایش داده شده و برای ارسال اعلان نیاز به کامل کردن این کد می‌باشد که در قسمت های دیگر راهنما توضیح داده خواهد شد

package main

import "net/http"

func main() {
    url := "some endpoint to call ..."

    client := &http.Client{}

    req, err := http.NewRequest("GET", url, nil)
    req.Headers.Set("Content-Type", "application/json")
    req.Headers.Set("Authorization", "Token YOUR_TOKEN")    

    resp, err := client.Do(req)
}