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

Версия API 1.1

В этой документации объясняется, как зарегистрировать, настроить и разработать ваше приложение, чтобы вы могли успешно использовать наши API

Создать приложение

Для того, чтобы ваше приложение смогло получить доступ к нашим APIs, вы должны зарегистрировать свое приложение с помощью Панель инструментов приложения. Регистрация создаёт идентификатор приложения, который позволяет нам знать, кто вы, помогает нам отличить ваше приложение от других приложений.

  1. Вам нужно будет создать новое приложение Создание нового приложения
  2. Как только вы создали приложение вы получите app_id и app_secret
Войти в с

Вход в систему - это быстрый и удобный способ для пользователей создавать учетные записи и входить в ваше приложение. Наш вход в систему позволяет использовать два сценария: аутентификацию и запрос разрешений на доступ к данным пользователей. Вы можете использовать вход в систему просто для аутентификации или как для аутентификации, так и для доступа к данным.

  1. Начиная процесс входа в систему OAuth, вам нужно использовать ссылку для вашего приложения, подобную этой:
    <a href="https://severomorsk-online.ru/api/oauth?app_id=YOUR_APP_ID">Log in With Улицы51 - Североморск</a>

    Пользователь будет перенаправлен для входа на страницу, подобную этой

  2. Как только пользователь примет ваше приложение, он будет перенаправлен на URL-адрес App Redirect с auth_key нравится это:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Это auth_key действителен только для однократного использования, поэтому после того, как вы его использовали, вы не сможете использовать его снова и сгенерируете новый код, вам нужно будет снова перенаправить пользователя на ссылку "Войти с помощью"..
Токен доступа

Как только вы получите одобрение пользователя вашего приложения, войдите в систему с помощью window и вернитесь с 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://severomorsk-online.ru/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://severomorsk-online.ru/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": ""
          }
        }