نسخه API 1.1

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

ایجاد برنامه

برای اینکه برنامه شما به API‌های ما دسترسی داشته باشد، باید برنامه خود را با استفاده از داشبورد برنامه. ثبت نام، یک شناسه برنامه (App ID) ایجاد می‌کند که به ما می‌فهماند شما چه کسی هستید و به ما کمک می‌کند برنامه شما را از سایر برنامه‌ها متمایز کنیم.

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

ورود با

سیستم ورود با (Log in With) راهی سریع و راحت برای افراد است تا حساب کاربری ایجاد کرده و وارد برنامه شما شوند. سیستم ورود با ما دو سناریو را فعال می‌کند: احراز هویت و درخواست مجوزها برای دسترسی به داده‌های افراد. می‌توانید از سیستم ورود با به سادگی برای احراز هویت یا برای احراز هویت و دسترسی به داده استفاده کنید.

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

   <a href="https://aminsocial.com/api/oauth?app_id=YOUR_APP_ID">Log in With شبکه اجتماعی امین</a>

   کاربر به صفحه ورود با (Log in With) مانند این هدایت خواهد شد

   
2. هنگامی که کاربر برنامه شما را پذیرفت، به URL تغییر مسیر برنامه شما به همراه auth_key مانند این:

   https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY

   این auth_key فقط برای یک بار استفاده معتبر است، بنابراین پس از استفاده از آن دیگر نمی‌توانید دوباره از آن استفاده کنید و برای تولید کد جدید باید کاربر را دوباره به لینک ورود با (log in with link) هدایت کنید.

توکن دسترسی

هنگامی که تأیید کاربر برای پنجره ورود با (Log in With) برنامه خود را دریافت کردید و با auth_key بازگشت، به این معنی است که اکنون آماده بازیابی داده‌ها از API‌های ما هستید و برای شروع این فرآیند باید برنامه خود را مجاز کنید و access_token را دریافت کنید و می‌توانید مراحل ما را دنبال کنید تا یاد بگیرید چگونه آن را بدست آورید.

1. برای دریافت توکن دسترسی، یک درخواست 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
   
   // Prepare the POST data
   $postData = [
     'app_id' => $app_id,
     'app_secret' => $app_secret,
     'auth_key' => $auth_key
   ];
   
   // Initialize cURL
   $ch = curl_init('https://aminsocial.com/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 فقط برای یک ساعت معتبر است، بنابراین پس از نامعتبر شدن، باید با هدایت مجدد کاربر به لینک ورود با (log in with link) یک توکن جدید ایجاد کنید.

APIها

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

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

if(!empty($json['access_token'])) {
    $access_token = $json['access_token']; // your access token
    $get = file_get_contents("https://aminsocial.com/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": ""
  }
}