Dokumentáció

API verzió 1.1

Ez a dokumentáció elmagyarázza, hogyan lehet regisztrálni, konfigurálni és fejleszteni az alkalmazását, hogy sikeresen használhassa API -kat

Hozzon létre alkalmazást

Annak érdekében, hogy az alkalmazás hozzáférhessen az API -khoz, regisztrálnia kell az alkalmazást a App Dashboard. A regisztráció létrehoz egy alkalmazást, amely tudatja velünk, hogy ki vagy, segít megkülönböztetni az alkalmazást a többi alkalmazástól.

  1. Új alkalmazást kell létrehoznia Új alkalmazás
  2. Miután létrehozta az alkalmazását, megkapja a app_id És app_secret
Jelentkezzen be

A bejelentkezés a rendszerrel gyors és kényelmes módja az embereknek a fiókok létrehozásához és az alkalmazásba való bejelentkezéshez. .

  1. Az OAuth bejelentkezési folyamat elindításakor az ilyen alkalmazáshoz linket kell használnia:
    <a href="https://social.hypehost.hu/api/oauth?app_id=YOUR_APP_ID">Log in With HypeSocial</a>

    A felhasználó átirányítja az ilyen oldallal való bejelentkezést

  2. Miután a felhasználó beillesztette az alkalmazását, a felhasználót átirányítják az alkalmazásába. auth_key Mint ez:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Ez auth_key Csak egyszeri használatra érvényes, tehát ha egyszer felhasználta, nem tudja újra használni, és új kódot generálhat, a felhasználót újra át kell irányítania a linkkel a bejelentkezéshez.
A hozzáférési jogkivitel

Miután megkapta az alkalmazás felhasználói jóváhagyását, jelentkezzen be az ablakkal, és visszatért a auth_key Ami azt jelenti, hogy most már készen áll az API -k adatkezelésére, és ennek a folyamatnak a megkezdéséhez fel kell engedélyeznie az alkalmazást, és megszereznie a access_token És követheti a lépéseinket, hogy megtanulja, hogyan lehet megszerezni.

  1. Ahhoz, hogy hozzáférési jogkivonatot kapjon, tegyen egy HTTP -t a következő végponthoz:
                <?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://social.hypehost.hu/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
                }
                ?>                                                                                                
                                
    Ez access_token Csak csak egy órán keresztül érvényes, tehát ha érvénytelen lett, újat kell átirányítani a felhasználót a linkkel való bejelentkezéshez.
API -k

Ha egyszer megkapja a access_token Mostantól információkat kérhet le a rendszerünkből HTTP GET kéréseken keresztül, amelyek a következő paramétereket támogatják

Végpont Leírás
api/get_user_info

felhasználói információk beszerzése

Az ehhez hasonló felhasználói információkat lekérheti

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

Az eredmény az lesz:

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