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

Версия API 1.1

This documentation explain how to register, configure, and develop your app so you can successfully use our APIs

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

In order for your app to access our APIs, you must register your app using the Панель инструментов приложения. Регистрация создаёт идентификатор приложения, который позволяет нам знать, кто вы, помогает нам отличить ваше приложение от других приложений.

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

Log in With system is a fast and convenient way for people to create accounts and log into your app. Our Log in With system enables two scenarios, authentication and asking for permissions to access people's data. You can use Login With system simply for authentication or for both authentication and data access.

  1. Starting the OAuth login process, You need to use a link for your app like this:
    <a href="https://mariulam.ru/api/oauth?app_id=YOUR_APP_ID">Log in With Марий Улам</a>

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

  2. Как только пользователь примет ваше приложение, он будет перенаправлен на URL-адрес App Redirect с auth_key нравится это:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Это auth_key valid only for one time usage, so once you used it you will not be able to use it again and generate new code you will need to redirect the user to the log in with link again.
Токен доступа

Once you get the user approval of your app Log in With window and returned with the auth_key which means that now you are ready to retrive data from our APIs and to start this process you will need to authorize your app and get the access_token и вы можете следовать нашим шагам, чтобы узнать, как получить его.

  1. To get an access token, make an HTTP GET request to the following endpoint like this:
                <?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://mariulam.ru/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 valid only for only one 1 hour, so once it got invalid you will need to genarte new one by redirect the user to the log in with link again.
API-интерфейсы

Как только вы получите access_token Now you can retrieve informations from our system via HTTP GET requests which supports the following parameters

Конечная точка Описание
api/get_user_info

получить информацию о пользователе

Вы можете получить информацию о пользователе, как это

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