文件

API 版本 1.1

本文檔說明瞭如何註冊,配置和開發您的應用,以便您可以成功使用我們的API

建立

為了使您的應用訪問我們的API,您必須使用 應用程式一覽. 註冊會創建一個應用ID,該ID可以讓我們知道您是誰,從而幫助我們將您的應用與其他應用區分開來.

  1. 您將需要創建一個新的應用程序 和創建新的應用程式
  2. 創建應用後,您將獲得 app_idapp_secret
登入

使用系統登錄是人們創建帳戶並登錄到您的應用程序的快速便捷的方法。我們的“登錄方式”系統支持兩種方案,即身份驗證和請求訪問人員數據的權限。您可以僅使用Login With系統進行身份驗證,也可以同時使用身份驗證和數據訪問.

  1. 開始OAuth登錄過程,您需要像這樣使用您應用的鏈接:
    <a href="https://ifvex.com/api/oauth?app_id=YOUR_APP_ID">Log in With Ifvex</a>

    用戶將被重定向到這樣的“登錄方式”頁面

  2. 用戶啟用您的應用後,該用戶將被重定向到您的“應用重定向網址” auth_key 人喜歡:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    分享 auth_key 僅在一次使用時有效,因此一旦使用,您將無法再次使用它並生成新代碼,您將需要將用戶重定向到再次通過鏈接登錄.
訪問權限

獲得應用程序的用戶批准後,“登錄方式”窗口將返回 auth_key 這意味著現在您準備好從我們的API檢索數據並開始此過程,您將需要授權您的應用並獲取 access_token 您可以參照以下步驟以了解如何取得.

  1. 要獲取訪問令牌,請像下面這樣向以下端點發出HTTP GET請求:
                <?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://ifvex.com/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 僅在1小時內有效一次,因此一旦無效,您將需要通過重新引導用戶到帶有鏈接的登錄名來生成新的.
接口

一旦獲得 access_token 現在,您可以通過支持以下參數的HTTP GET請求從我們的系統中檢索信息

端點 描述
api/get_user_info

獲取用戶信息

您可以像這樣檢索用戶信息

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