مستندات

نسخه API 1.1

این اسناد نحوه ثبت نام، پیکربندی و توسعه برنامه شما را توضیح می دهد تا بتوانید با موفقیت از API های ما استفاده کنید

ایجاد برنامه

برای اینکه برنامه شما به API های ما دسترسی پیدا کند، باید برنامه خود را با استفاده از ثبت کنید داشبورد برنامه. ثبت نام، یک ID برنامه ایجاد می کند که به ما اجازه می دهد شما را بشناسیم و به ما کمک می کند برنامه شما را از برنامه های دیگر تشخیص دهیم.

  1. شما باید یک برنامه جدید ایجاد کنید ایجاد برنامه جدید
  2. هنگامی که برنامه خود را ایجاد کردید، برنامه خود را دریافت خواهید کرد app_id و app_secret
ورود به سیستم با

ورود با سیستم یک روش سریع و راحت برای افراد برای ایجاد حساب ها و ورود به برنامه شما است. ورود ما با سیستم، دو حالت احراز هویت و درخواست مجوز برای دسترسی به داده های افراد را امکان پذیر می کند. شما می توانید برای ورود با سیستم فقط برای تأیید اعتبار یا هم برای تأیید اعتبار و هم دسترسی داده ها از سیستم استفاده کنید.

  1. با شروع روند ورود به سیستم OAuth، باید از لینکی مانند این برای برنامه خود استفاده کنید:
    <a href="https://sidane.ir/api/oauth?app_id=YOUR_APP_ID">Log in With روبیکس</a>

    کاربر ارجاع داده خواهد شد به ورود به سیستم با صفحه شبیه به این

  2. هنگامی که کاربر برنامه شما را پذیرفت، کاربرارجاع داده خواهد شد به URL ارجاعی برنامه شما با auth_key مثل این:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    این auth_key فقط برای یکبار استفاده معتبر است، بنابراین با استفاده از آن دیگر قادر به استفاده مجدد از آن و تولید کد جدید نخواهید بود، باید کاربر را مجدداً به سیستم با لینک وارد کنید .
Access Token

پس از دریافت تأیید کاربر از برنامه خود، پنجره ورود به سیستم را با سیستم وارد کنید auth_key این بدان معناست که اکنون شما آماده بازیابی اطلاعات از API های ما هستید و برای شروع این فرآیند باید به برنامه خود اجازه دهید و د ریافت کنید access_token و می توانید برای یادگیری نحوه دستیابی، مراحل ما را دنبال کنید.

  1. برای به دست آوردن token دسترسی، از این قسمت درخواست HTTP GET را به نقطه پایانی زیر وارد کنید:
    <?php
        $app_id = "YOUR_APP_ID"; // your app id
        $app_secret = "YOUR_APP_SECRET"; // your app secret
        $auth_key = $_GET['auth_key']; // the returned auth key from previous step
    
        $get = file_get_contents("https://sidane.ir/api/authorize?app_id=$app_id&app_secret=$app_secret&auth_key=$auth_key");
    
        $json = json_decode($get, true);
        if(!empty($json['access_token'])) {
            $access_token = $json['access_token']; // your access token
        }
        ?>
    این access_token فقط فقط 1 ساعت معتبر است، پس از نامعتبر شدن شما باید با هدایت مجدد کاربر به سیستم ورود به سیستم با پیوند ، ساعت جدید را ایجاد کنید..
APIs

هنگامی که شما خود را دریافت کنید access_token اکنون می توانید اطلاعات را از طریق درخواست های HTTP GET که از پارامترهای زیر پشتیبانی می کند، از سیستم ما بازیابی کنید

نقطه پایان شرح
api/get_user_info

دریافت اطلاعات کاربر

می توانید اطلاعات کاربر را مانند این بازیابی کنید

if(!empty($json['access_token'])) {
       $access_token = $json['access_token']; // your access token
       $get = file_get_contents("https://sidane.ir/api/get_user_info?access_token=$access_token");
    }

نتیجه خواهد بود:

{
        "user_info": {
            "user_id": "",
            "user_name": "",
            "user_email": "",
            "user_firstname": "",
            "user_lastname": "",
            "user_gender": "",
            "user_birthdate": "",
            "user_picture": "",
            "user_cover": "",
            "user_registered": "",
            "user_verified": "",
            "user_relationship": "",
            "user_biography": "",
            "user_website": ""
        }
    }