Documentare

Versiune API 1.1

Această documentație explică cum să înregistrați, să configurați și să dezvoltați aplicația dvs., astfel încât să puteți utiliza cu succes API-urile noastre

Creați o aplicație

Pentru ca aplicația dvs. să acceseze API-urile noastre, trebuie să o înregistrați folosind Tablou de bord al aplicației. Înregistrarea creează un ID de aplicație care ne permite să știm cine sunteți și ne ajută să distingem aplicația dvs. de alte aplicații.

  1. Va trebui să creați o aplicație nouă Creați o aplicație nouă
  2. După ce ți-ai creat aplicația, vei primi app_id şi app_secret
Conectați-vă cu

Sistemul „Conectare cu” este o modalitate rapidă și convenabilă prin care utilizatorii își pot crea conturi și se pot conecta la aplicația dvs. Sistemul nostru „Conectare cu” permite două scenarii: autentificarea și solicitarea permisiunilor de acces la datele utilizatorilor. Puteți utiliza sistemul „Conectare cu” pur și simplu pentru autentificare sau atât pentru autentificare, cât și pentru acces la date.

  1. Pentru a porni procesul de conectare OAuth, trebuie să utilizați un link pentru aplicația dvs., cum ar fi acesta:
    <a href="https://soclio.com/api/oauth?app_id=YOUR_APP_ID">Log in With SOCLIO</a>

    Utilizatorul va fi redirecționat către pagina de Autentificare ca aceasta

  2. După ce utilizatorul a acceptat aplicația dvs., acesta va fi redirecționat către adresa URL de redirecționare a aplicației dvs. cu auth_key ca aceasta:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Acest auth_key valabil doar pentru o singură utilizare, deci odată ce l-ați folosit nu îl veți mai putea folosi din nou și nu veți putea genera cod nou. Va trebui să redirecționați utilizatorul din nou către linkul de conectare.
Access Token

După ce obțineți aprobarea utilizatorului pentru aplicația dvs., fereastra Conectare cu și ați revenit cu auth_key ceea ce înseamnă că acum sunteți gata să recuperați date din API-urile noastre și, pentru a începe acest proces, va trebui să autorizați aplicația și să obțineți access_token și puteți urma pașii noștri pentru a afla cum să îl obțineți.

  1. Pentru a obține un token de acces, faceți o cerere HTTP GET către următorul punct final, astfel:
            <?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://soclio.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
            }
            ?>
            
    Acest access_token valabil doar pentru o oră, așa că odată ce devine invalid, va trebui să generați unul nou redirecționând utilizatorul către linkul de conectare.
API-uri

Odată ce primești access_token Acum puteți recupera informații din sistemul dvs. prin intermediul cererilor HTTP GET, care acceptă următorii parametri

Endpoint Descriere
api/get_user_info

obține informații despre utilizator

Puteți recupera informații despre utilizatori astfel

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

Rezultatul va fi:

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