نسخه API 1.1

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

ایجاد اپلیکیشن

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

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

ورود با

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

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

   <a href="https://ugeram.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 این فقط برای استفاده یک‌بار معتبر است، پس از استفاده از آن، شما قادر نخواهید بود که دوباره از آن استفاده کنید و برای تولید کد جدید، شما باید کاربر را به لینک ورود دوباره هدایت کنید.

توکن دسترسی

پس از اینکه شما تأیید کاربر را برای پنجره ورود اپلیکیشن خود دریافت کردید، و آن را با شناسه ارسال کردید auth_key which means that now you are ready to retrive data from our APIs and to start this process you will need to authorize your app and get the access_token and you can follow our steps to learn how to get it.

1. To get an access token, make an HTTP GET request to the following endpoint like this:

   <?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
   
   // Prepare the POST data
   $postData = [
     'app_id' => $app_id,
     'app_secret' => $app_secret,
     'auth_key' => $auth_key
   ];
   
   // Initialize cURL
   $ch = curl_init('https://ugeram.ir/api/authorize');
   
   // Set cURL options for POST
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
   curl_setopt($ch, CURLOPT_POST, true);
   curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
   
   // Execute request
   $response = curl_exec($ch);
   
   // Check for cURL errors
   if (curl_errno($ch)) {
     die('cURL error: ' . curl_error($ch));
   }
   
   curl_close($ch);
   
   // Decode the JSON response
   $json = json_decode($response, true);
   
   // Use the access token if available
   if (!empty($json['access_token'])) {
     $access_token = $json['access_token']; // your access token
   }
   ?>
   

   این access_token valid only for only one 1 hour, so once it got invalid you will need to genarte new one by redirect the user to the log in with link again.

APIs

Once you get your access_token Now you can retrieve informations from our system via HTTP GET requests which supports the following parameters

You can retrive user info like this

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

The result will be:

{
    "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": ""
    }
}