How to write PHP backend interface

How to implement the php backend interface

1. First, set up an entry file

The entry file will be imported into the fixed api file (as shown below):

<?php
define("APPAPI_ALLOW_REQUEST_LOGIN", &#39;Y&#39;);
//是否允许传用户名密码参数的形式登录。如为Y则参数用户名密码参数和basic方式都可以，如为N就只能basic方式。
//define("SITE_TEMPLATE_PATH", &#39;/local/templates/mobile_app_api&#39;);
//如不定义，默认是local/templates/bitrix24。可以考虑将/local/templates/mobile_app留给h5前端展示用。
新开/local/templates/mobile_app_api给api用。如不指定SITE_TEMPLATE_PATH直接IncludeComponent，则对组件代码进行debug时，
会出现web端头部页面。
//require_once($_SERVER[&#39;DOCUMENT_ROOT&#39;] . &#39;/bitrix/header.php&#39;);  //需要模板页面
Header(&#39;Access-Control-Allow-Origin: *&#39;);
Header(&#39;Access-Control-Allow-Headers: origin, content-type, accept&#39;);
Header(&#39;X-Content-Type-Options: nosniff&#39;);
require("remote_auth.php");
//app方式每次请求session_id()都会变，导致挂钩在session_id()下面的所有session信息如fix_session_id也都不认。
所以登录完毕后要拿到session_id()，并在后续接口一起传给接口，接口再去指定session_id。
//$_REQUEST[&#39;org_sessid&#39;]=&#39;06q75330o31se1cf4d7vl1bdm4&#39;;
if(!empty($_REQUEST[&#39;org_sessid&#39;])){
    $org_session_id=$_REQUEST[&#39;org_sessid&#39;];
    session_id($org_session_id);
    session_start();
    //echo session_id();
    //echo "<pre class="brush:php;toolbar:false">";print_r($_SESSION);exit;
}
require_once($_SERVER["DOCUMENT_ROOT"] . "/bitrix/modules/main/include/prolog_before.php");   //无需模板页面
$APPLICATION->IncludeComponent("vdg:mobile.data", "", Array());
exit;
?>

2. Secondly, obtain the parameters in component.php of the imported component and determine the use of the template

<?php
...
include_once(dirname(__FILE__) . "/functions.php");//引入类的方法的文件
...
if ($_REQUEST["mobile_action"])//Executing some action
{
    $APPLICATION->RestartBuffer();
    $action = $_REQUEST["mobile_action"];
    //CRestUtil::sendHeaders();  //跨域header
    $actionList = new Bitrix\Mobile\Action();
    $actionList->executeAction($action, $arParams);

    CMain::FinalActions();
    die();
}
elseif ($_REQUEST["captcha_sid"])//getting captcha image  通过 /vdg/app_api.php?captcha_sid=1 可以得到图形验证码。
{
    $APPLICATION->RestartBuffer();
    $actionList = new Bitrix\Mobile\Action();
    $actionList->executeAction("get_captcha", $arParams);
    die();
}
elseif ($_REQUEST["manifest_id"])//getting content of appcache manifest
{
    include($_SERVER["DOCUMENT_ROOT"] .\Bitrix\Main\Data\AppCacheManifest::MANIFEST_CHECK_FILE);
    die();
}
elseif(!$USER->IsAuthorized() || !$isSessidValid)
{
    $APPLICATION->RestartBuffer();
    header("HTTP/1.0 401 Not Authorized");
    if(Bitrix\MobileApp\Mobile::getInstance()->getInstance() != "android")
    {
        //header("Content-Type: application/x-javascript");
        header("Content-Type: application/json");
        header("BX-Authorize: ".bitrix_sessid());
    }

    jsonError(&#39;201&#39;, &#39;请先登陆&#39;);
    //echo json_encode(Array("status" => "failed", "bitrix_sessid"=>bitrix_sessid()));
    die();
}
?>

3. Use the class method in the specific template to obtain the corresponding data according to the parameters and return the client result

If the result returns "jsonSuccess(questions);" If it fails, it returns "jsonError(′201′,questions);"

If it fails, return "jsonError('201′,questRes["ERROR"]);" or other error message.

Recommended tutorial: PHP video tutorial

The above is the detailed content of How to write PHP backend interface. For more information, please follow other related articles on the PHP Chinese website!