Dokumentacja

Wersja API 1.1

W tej dokumentacji wyjaśniono, jak zarejestrować, skonfigurować i opracować aplikację, aby można było z powodzeniem korzystać z naszych interfejsów API

Stwórz aplikację

Aby aplikacja uzyskiwała dostęp do naszych interfejsów API, musisz zarejestrować aplikację za pomocą Pulpit nawigacyjny aplikacji. Rejestracja tworzy identyfikator aplikacji, który informuje nas, kim jesteś, pomaga nam odróżnić Twoją aplikację od innych aplikacji.

  1. Musisz utworzyć nową aplikację Utwórz nową aplikację
  2. Po utworzeniu aplikacji otrzymasz app_id i app_secret
Zaloguj się za pomocą

Zaloguj się za pomocą systemu to szybki i wygodny sposób tworzenia kont i logowania się do aplikacji. Nasz system Log in With umożliwia dwa scenariusze, uwierzytelnianie i prośbę o uprawnienia dostępu do danych osób. Możesz użyć login with system po prostu do uwierzytelniania lub zarówno do uwierzytelniania, jak i dostępu do danych.

  1. Rozpoczynając proces logowania OAuth, musisz użyć linku do swojej aplikacji w ten sposób:
    <a href="https://locusmind.one/api/oauth?app_id=YOUR_APP_ID">Log in With Locus</a>

    Użytkownik zostanie przekierowany do strony Zaloguj się z taką stroną

  2. Gdy użytkownik zaakceptuje Twoją aplikację, zostanie przekierowany na adres URL przekierowania aplikacji za pomocą auth_key lubi to:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    auth_key ważny tylko dla jednorazowego użycia, więc po jego użyciu nie będziesz mógł go ponownie użyć i wygenerować nowego kodu, będziesz musiał ponownie przekierować użytkownika do logowania z linkiem.
Token dostępu

Po uzyskaniu zgody użytkownika na aplikację Zaloguj się za pomocą okna i zwróceniu z auth_key co oznacza, że teraz jesteś gotowy do retrive danych z naszych interfejsów API i aby rozpocząć ten proces, musisz autoryzować swoją aplikację i uzyskać access_token wykonuj kolejne kroki, aby dowiedzieć się jak to zrobic.

  1. Aby uzyskać token dostępu, wprowadź żądanie HTTP GET do następującego punktu końcowego, takiego jak ten:
                <?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://locusmind.one/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 ważny tylko przez 1 godzinę, więc gdy stanie się nieważny, musisz wygenerować nowy, przekierowując użytkownika do logowania za pomocą linku ponownie.
APIs

Po otrzymaniu access_token Teraz możesz pobierać informacje z naszego systemu za pośrednictwem żądań HTTP GET, które obsługują następujące parametry

Punkt końcowy Opis
api/get_user_info

uzyskaj informacje o użytkowniku

Możesz odzyskać informacje użytkownika w ten sposób

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

Rezultatem będzie:

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