Dokumentácia

Verzia rozhrania API 1.1

Táto dokumentácia vysvetľuje, ako zaregistrovať, nakonfigurovať a vyvinúť aplikáciu, aby ste mohli úspešne používať naše rozhrania API

Vytvoriť aplikáciu

Ak chcete, aby vaša aplikácia mala prístup k našim rozhraniam API, musíte ju zaregistrovať pomocou Tabuľa aplikácie. Registrácia vytvorí ID aplikácie, ktoré nám dá vedieť, kto ste, pomáha nám odlíšiť vašu aplikáciu od ostatných aplikácií.

  1. Budete musieť vytvoriť novú aplikáciu Vytvoriť novú aplikáciu
  2. Po vytvorení aplikácie získate svoje app_id a app_secret
Prihlásiť sa cez

Prihlásiť sa pomocou systému je rýchly a pohodlný spôsob, ako si ľudia môžu vytvoriť účty a prihlásiť sa do vašej aplikácie. Náš systém prihlásenia pomocou umožňuje dva scenáre, autentifikáciu a žiadosť o povolenie na prístup k údajom ľudí. Systém Prihlásenie pomocou môžete použiť jednoducho na autentifikáciu alebo na autentifikáciu aj prístup k údajom.

  1. Po spustení procesu prihlásenia OAuth musíte pre svoju aplikáciu použiť odkaz, ako je tento:
    <a href="https://social.unitychrist.org/api/oauth?app_id=YOUR_APP_ID">Log in With Unity Christ Social Network</a>

    Používateľ bude presmerovaný na stránku Prihlásiť sa pomocou ako je táto

  2. Keď používateľ prijme vašu aplikáciu, bude presmerovaný na vašu URL adresu presmerovania aplikácie pomocou auth_key ako je tento:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Tento auth_key platí len na jednorazové použitie, takže akonáhle ho použijete, nebudete ho môcť znova použiť a vygenerovať nový kód, budete musieť používateľa znova presmerovať na prihlásiť sa s odkazom.
Prístupový token

Po získaní súhlasu používateľa s aplikáciou sa prihláste v okne a vráťte sa s auth_key čo znamená, že teraz ste pripravení vyčistiť údaje z našich rozhraní API a na spustenie tohto procesu budete musieť autorizovať svoju aplikáciu a získať access_token a podľa našich krokov sa dozviete, ako ho získať.

  1. Ak chcete získať prístupový token, vytvorte požiadavku HTTP GET na nasledujúci koncový bod, ako je tento:
                <?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.unitychrist.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
                }
                ?>                                                                                                
                                
    Tento access_token platí len jednu 1 hodinu, takže akonáhle sa stane neplatným, budete musieť znova presmerovať používateľa na prihlásiť sa pomocou odkazu.
Rozhrania API

Akonáhle získate svoj access_token Teraz môžete načítať informácie z nášho systému prostredníctvom požiadaviek HTTP GET, ktoré podporujú nasledujúce parametre

Koncový bod Popis
api/get_user_info

informácie o používateľovi

Informácie o používateľovi môžete získať takto

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

Výsledok bude:

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