Dokumentáció

API verzió 1.1

Ez a dokumentáció bemutatja, hogyan regisztrálhatja, konfigurálhatja és fejlesztheti alkalmazását az API-k sikeres használata érdekében

Alkalmazás létrehozása

Ahhoz, hogy alkalmazásod hozzáférhessen API-jainkhoz, regisztrálnod kell az alkalmazásodat a Alkalmazás irányítópultja. A regisztráció létrehoz egy alkalmazásazonosítót, amely tudatja velünk, hogy ki vagy, és segít megkülönböztetni az alkalmazásodat más alkalmazásoktól.

  1. Létre kell hoznia egy új alkalmazást Új alkalmazás létrehozása
  2. Miután létrehozta az alkalmazást, megkapja a app_id és app_secret
Belépés ezzel

Bejelentkezés a rendszerrel egy gyors és kényelmes módszer az emberek számára fiókok létrehozására és az alkalmazásba való bejelentkezésre. A Belépés rendszerünk két forgatókönyvet tesz lehetővé: hitelesítés és engedélyek kérése az emberek adatainak eléréséhez. A Bejelentkezés a rendszerrel funkciót egyszerűen a hitelesítéshez, illetve a hitelesítéshez és az adatokhoz való hozzáféréshez is használhatja.

  1. Az OAuth bejelentkezési folyamat elindításához ehhez kell használnia egy linket az alkalmazásához:
    <a href="https://havenclub.hu/api/oauth?app_id=YOUR_APP_ID">Log in With HavenClub</a>

    A felhasználót átirányítják a Belépés oldalra, mint ez

  2. Miután a felhasználó elfogadta az alkalmazását, a felhasználót átirányítják az alkalmazás átirányítási URL-jére a következővel auth_key ez tetszik:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Ez az auth_key csak egyszeri felhasználásra érvényes, így ha egyszer használta, nem fogja tudni újra használni, és új kódot generálni, a felhasználót újra a linkre kell irányítania a bejelentkezéshez.
Hozzáférési token

Miután megkapta az alkalmazás felhasználói jóváhagyását, jelentkezz be a Bejelentkezés ablakba, majd visszatérjen a auth_key ami azt jelenti, hogy most már készen áll az adatok beolvasására az API-kból, és ennek a folyamatnak a megkezdéséhez engedélyeznie kell alkalmazását, és meg kell szereznie a access_token és követheti a lépéseinket, hogy megtanulja, hogyan lehet megszerezni.

  1. A hozzáférési jogkivonat megszerzéséhez készítsen egy HTTP GET kérést 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://havenclub.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 az access_token csak 1 órán keresztül érvényes, tehát ha érvénytelenné válik, akkor újat kell genarterezni úgy, hogy a felhasználót a linkkel történő újbóli bejelentkezéshez átirányítja.
API-k

Miután megkapta a access_token Most már HTTP GET kéréseken keresztül is lekérheti rendszerünkből az információkat, amely a következő paramétereket támogatja

Végpont Leírás
api/get_user_info

Felhasználói adatok lekérése

A felhasználói adatokat az alábbi módon kérheti le:

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

Az eredmény a következő 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": ""
              }
            }