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

Версия API 1.1

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

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

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

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

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

  1. Начиная процесс входа в OAuth, вы должны использовать ссылку для своего приложения, как это:
    <a href="https://thinktank.x-pulse.org//api/oauth?app_id=YOUR_APP_ID">Log in With X-Pulse, the HO1 Think Tank</a>

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

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

Как только вы получите одобрение вашего приложения, войдите в систему в оконном режиме и вернитесь с auth_key это означает, что теперь вы готовы извлечь данные из наших APIs и начать этот процесс, вам нужно будет авторизовать ваше приложение и получить 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
    
                $get = file_get_contents("https://thinktank.x-pulse.org//api/authorize?app_id=$app_id&app_secret=$app_secret&auth_key=$auth_key");
    
                $json = json_decode($get, true);
                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://thinktank.x-pulse.org//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": ""
              }
            }