Documentación

Versión de la API 1.1

Esta documentación explica cómo registrar, configurar y desarrollar tu app para usar nuestras APIs

Crear app

Para que tu app acceda a nuestras APIs, debes registrarla en el Panel de apps. El registro crea un App ID que nos indica quién eres y distingue tu app de las demás.

  1. Tendrás que crear una app nueva Crear nueva app
  2. Cuando crees tu app obtendrás tu app_id y app_secret
Iniciar sesión con

Iniciar sesión con es una forma rápida de crear cuentas y acceder a tu app. Permite autenticación y solicitar permisos para acceder a datos. Puedes usarlo solo para autenticar o también para acceder a datos.

  1. Para iniciar el proceso OAuth, usa un enlace de tu app como este:
    <a href="https://virtuala.site/api/oauth?app_id=YOUR_APP_ID">Log in With Virtuala FansOnly </a>

    El usuario será redirigido a la página de Iniciar sesión con, así

  2. Cuando el usuario acepte tu app, será redirigido a tu URL de redirección con auth_key así:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Este auth_key solo es válido una vez; cuando lo uses no podrás reutilizarlo y para generar uno nuevo deberás redirigir al usuario al enlace de inicio de sesión.
Access Token

Cuando el usuario acepte tu app en la ventana de Iniciar sesión con y vuelva con el auth_key significa que ya puedes obtener datos de nuestras APIs; para ello autoriza tu app y obtén el access_token y puedes seguir nuestros pasos para saber cómo obtenerlo.

  1. Para obtener un access token, haz una petición HTTP GET a este endpoint:
            <?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
            }
            ?>
            
    Este access_token solo es válido 1 hora; cuando caduque, genera uno nuevo redirigiendo al usuario al enlace de inicio de sesión.
APIs

Cuando tengas tu access_token Ya puedes obtener información de nuestro sistema con peticiones HTTP GET que admiten estos parámetros

Endpoint Descripcion
api/get_user_info

obtener información del usuario

Puedes obtener la información del usuario así

        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");
        }
        

El resultado será:

        {
          "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": ""
          }
        }
        
Virtuala FansOnly https://virtuala.site