Документація

Версія API 1.1

Ця документація пояснює, як зареєструвати, налаштувати та розробити ваш додаток для успішного використання наших API

Створити додаток

Щоб ваш додаток мав доступ до наших API, потрібно зареєструвати його через Панель керування додатком. Реєстрація створює ID додатку, що дозволяє нам розпізнавати вас та відрізняти ваш додаток від інших.

  1. Вам потрібно створити новий додаток Створити Новий Додаток
  2. Після створення додатку ви отримаєте ваш app_id та app_secret
Увійти за допомогою

Вхід через систему — це швидкий та зручний спосіб створити обліковий запис і увійти у ваш додаток. Наша система входу дозволяє два сценарії: автентифікацію та запит дозволів на доступ до даних користувача. Ви можете використовувати її лише для автентифікації або і для автентифікації, і для отримання доступу до даних.

  1. Запуск процесу входу через OAuth. Вам потрібно використати посилання для вашого додатку, як це:
    <a href="https://myrazom.com/api/oauth?app_id=YOUR_APP_ID">Log in With Myrazom - Соціальна мережа МиРазом</a>

    Користувача буде перенаправлено на сторінку Увійти через, як це

  2. Після того, як користувач прийме ваш додаток, його буде перенаправлено на URL переадресації вашого додатку з auth_key як це:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Цей auth_key дійсний лише для одноразового використання, тому після використання ви не зможете використати його знову, і щоб згенерувати новий код, вам потрібно знову перенаправити користувача на посилання входу.
Access токен

Після отримання підтвердження користувача щодо входу через вікно входу вашого додатку та повернення з 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://myrazom.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 дійсний лише протягом 1 години, тому після його закінчення вам потрібно буде згенерувати новий, перенаправивши користувача знову на посилання входу.
API

Після отримання вашого access_token Тепер ви можете отримувати інформацію з нашої системи за допомогою HTTP GET запитів, які підтримують наступні параметри

Кінцева точка Опис
api/get_user_info

отримати інформацію про користувача

Ви можете отримати інформацію про користувача так

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