文档

API 版本 1.1

本文档介绍了如何注册、配置和开发您的应用程序,以便您可以成功使用我们的 API

创建应用

为了让您的应用程序访问我们的 API,您必须使用 应用面板. 注册会创建一个应用 ID,让我们知道您是谁,帮助我们将您的应用与其他应用区分开来.

  1. 您将需要创建一个新的应用程序 创建新应用
  2. 一旦你创建了你的应用,你会得到你的 app_idapp_secret
登录使用

使用系统登录是人们创建帐户并登录到您的应用程序的快速便捷的方法。 我们的“登录方式”系统支持两种方案,即身份验证和请求访问人员数据的权限。 您可以仅使用Login With系统进行身份验证,也可以同时使用身份验证和数据访问.

  1. 开始 OAuth 登录过程时,您应该像这样使用您的应用程序的链接:
    <a href="https://t.pineal.cn/api/oauth?app_id=YOUR_APP_ID">Log in With Facebook</a>

    用户将被重定向到这样的登录页面

  2. 一旦用户加入了你的应用,用户将被重定向到你的应用重定向URL,其中包括 auth_key 喜欢这个:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    这个 auth_key 只能使用一次,所以一旦你使用了它,就不能再使用它,并生成新的代码,你需要重新引导用户登录到有链接的地方.
访问令牌

一旦你得到了用户的app登录窗口的批准,并返回与 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://t.pineal.cn/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小时,所以一旦失效,你需要通过重定向用户重新登录到新的链接,重新生成一个新的链接.
API 密钥

一旦你得到了 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://t.pineal.cn/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": ""
              }
            }