نسخه API 1.1

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

ایجاد برنامه

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

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

ورود با

سیستم ورود با سیستم (ورود با) راهی سریع و راحت برای افراد است تا حساب کاربری ایجاد کرده و وارد برنامه شما شوند. سیستم ورود با سیستم ما دو سناریو را فعال می‌کند، احراز هویت و درخواست مجوز برای دسترسی به داده‌های افراد. می‌توانید از سیستم ورود با سیستم صرفاً برای احراز هویت یا برای احراز هویت و دسترسی به داده‌ها استفاده کنید.

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

   <a href="https://virtuala.site/api/oauth?app_id=YOUR_APP_ID">Log in With Virtuala FansOnly </a>

   کاربر به صفحه ورود با چیزی شبیه به این هدایت خواهد شد

   
2. پس از اینکه کاربر برنامه شما را پذیرفت، با استفاده از دستور زیر به آدرس اینترنتی تغییر مسیر برنامه شما هدایت می‌شود. auth_key مثل این:

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

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

توکن دسترسی

هنگامی که تأیید کاربر برنامه خود را دریافت کردید، با پنجره وارد شوید و با آن برگردید 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://virtuala.site/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 فقط برای یک ساعت معتبر است، بنابراین پس از نامعتبر شدن، باید با هدایت کاربر به لینک ورود، لینک جدیدی ایجاد کنید.

API ها

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

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

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