Tài liệu

Phiên bản API 1.1

Tài liệu này giải thích cách đăng ký, định cấu hình và phát triển ứng dụng của bạn để bạn có thể sử dụng thành công API của chúng tôi

Tạo App

Để ứng dụng của bạn truy cập API của chúng tôi, bạn phải đăng ký ứng dụng của mình bằng cách sử dụng Bảng điều khiển ứng dụng. Đăng ký tạo ID ứng dụng cho phép chúng tôi biết bạn là ai, giúp chúng tôi phân biệt ứng dụng của bạn với các ứng dụng khác.

  1. Bạn sẽ cần tạo một Ứng dụng mới Tạo App mới
  2. Khi bạn đã tạo Ứng dụng của mình, bạn sẽ nhận được app_idapp_secret
Đăng nhập với

Đăng nhập bằng hệ thống là cách nhanh chóng và thuận tiện để mọi người tạo tài khoản và đăng nhập vào ứng dụng của bạn. Đăng nhập với hệ thống của chúng tôi cho phép hai kịch bản, xác thực và yêu cầu quyền truy cập dữ liệu của mọi người. Bạn có thể sử dụng Đăng nhập với hệ thống chỉ để xác thực hoặc cho cả xác thực và truy cập dữ liệu.

  1. Bắt đầu quá trình đăng nhập OAuth, Bạn cần sử dụng một liên kết cho ứng dụng của bạn như thế này:
    <a href="https://ifvex.com/api/oauth?app_id=YOUR_APP_ID">Log in With Ifvex</a>

    Người dùng sẽ được chuyển hướng đến Đăng nhập bằng trang như thế này

  2. Khi người dùng chấp nhận ứng dụng của bạn, người dùng sẽ được chuyển hướng đến URL Chuyển hướng ứng dụng của bạn với auth_key như thế này:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Điều này auth_key chỉ hợp lệ cho một lần sử dụng, vì vậy một khi bạn đã sử dụng nó, bạn sẽ không thể sử dụng lại và tạo mã mới, bạn sẽ cần chuyển hướng người dùng đến đăng nhập bằng liên kết một lần nữa.
Truy cập Token

Khi bạn nhận được sự chấp thuận của người dùng đối với ứng dụng của mình, hãy đăng nhập với cửa sổ và quay lại với auth_key điều đó có nghĩa là bây giờ bạn đã sẵn sàng truy xuất dữ liệu từ các API của chúng tôi và để bắt đầu quá trình này, bạn sẽ cần phải ủy quyền cho ứng dụng của mình và nhận được access_token và bạn có thể làm theo các bước của chúng tôi để tìm hiểu làm thế nào để có được nó.

  1. Để nhận mã thông báo truy cập, hãy tạo một yêu cầu HTTP GET đến điểm cuối sau như thế này:
                <?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
                }
                ?>                                                                                                
                                
    Điều này access_token chỉ có hiệu lực trong một giờ, vì vậy một khi nó không hợp lệ, bạn sẽ cần phải tạo một cái mới bằng cách chuyển hướng người dùng đến đăng nhập bằng liên kết.
API

Một khi bạn nhận được access_token Bây giờ bạn có thể truy xuất thông tin từ hệ thống của chúng tôi thông qua các yêu cầu HTTP GET hỗ trợ các tham số sau

Điểm cuối Mô tả
api/get_user_info

lấy thông tin người dùng

Bạn có thể lấy thông tin người dùng như thế này

            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");
            }
                        

Kết quả sẽ là:

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