Как развернуть REST API на 1С-Битрикс?

Question

[Дмитрий Дев]

Я нашел файлик, как понимаю, для REST API, лежал он в /bitrix/modules/rest/services/rest/index.php. Его я себе скопировал в папку /rest/. Сделал к нему запрос http://domain.ru/rest/methods, он мне выдал wrong_authorization. Нашел я компонент rest.token, вывел его на странице /rest/auth/. При запросе http://domain.ru/rest/auth/ выдает wrong_client. В коде этого компонента полазил, но пока так и не понял как передать ему клиента и получить токен.
Вывел на странице еще компонент rest.authorize и обратился к странице http://domain.ru/rest/authorize/?client_id=1, но тут возникает ошибка:

No client credentials (0)
../bitrix/modules/rest/lib/oauth/client.php:167

Что дальше?

Answer 1

[MaxKozlov]

Источники мудрости
Rest API от Bitrix24
Статья от intervolga
Возможно, вариант решения через bitrix:rest.marketplace.localapp. У меня не заработало
Рабочее решение

https обязателен

1. Предполагается что страничка секретная или даже одноразовая, только для получения хука
   /local/rest/index.php
   

   <?php require_once($_SERVER['DOCUMENT_ROOT'] . 
       "/bitrix/modules/main/include/prolog_admin.php"); ?>
      <div class="adm-workarea">
          <? $APPLICATION->IncludeComponent(
              "bitrix:rest.hook",
              ".default",
              [
                  "SEF_MODE" => "Y",
                  "SEF_FOLDER" => "/local/rest/",
                  "COMPONENT_TEMPLATE" => ".default",
                  "SEF_URL_TEMPLATES" => [
                      "list" => "",
                      "event_list" => "event/",
                      "event_edit" => "event/#id#/",
                      "ap_list" => "ap/",
                      "ap_edit" => "ap/#id#/",
                  ]
              ],
              false
          ); ?>
          <br>
          <a href="javascript:void(0)" class="adm-btn adm-btn-green"
              onclick="BX.PopupMenu.show('rest_hook_menu', this, [{
                 'href':'/local/rest/event/0/',
                 'text':'Исходящий вебхук'
              },{
                 'href':'/local/rest/ap/0/',
                 'text':'Входящий вебхук'
              }])">
              Добавить вебхук
          </a>
      </div>
   <? require($_SERVER["DOCUMENT_ROOT"] . "/bitrix/modules/main/include/epilog_admin.php");

   
   
2. в urlrewrite.php добавляем
   

   array(
      'CONDITION' => '#^/local/rest/#',
      'RULE' => '',
      'ID' => 'bitrix:rest.hook',
      'PATH' => '/local/rest/index.php',
   ),

   
   
3. Надо убедиться, что urlrewrite.php битрикса отрабатывает ссылки на нашу страницу вида /local/rest/ap/0/
   
4. Заходим на свежесозданную страницу, добавляем там свой входящий хук
   
5. Получаем пару client_id / secret_id
   
6. Используем в запросах вида
   

   https: //site.domain/rest/17607/p8n2dh2hf2nf258n/profile/

   
   

Comments

[Дмитрий Дев]

MaxKozlov а там нигде не написано, как получить client_id если у тебя БУС и у тебя нет окна для создания хука или локального приложения. Сами разворачивали REST API на БУС прежде чем такие сообщения писать?

[MaxKozlov]

Дмитрий Дев, Нет, сам не разворачивал.
Но раз уж вы настаиваете, сделаю это "при вас"

[MaxKozlov]

Итак. Сразу скажу что я ни разу не админ или программист битрикса, я сисадмин. php знаю на уровне синтаксиса. С битриксом общался на уровне установки на сервер и знакомства с его rest api

БУС у меня в доступности оказался изрядно покоцаным нашими админами битрикса.
Поставил на нём модуль rest
урла site.domain/rest показывала 404
полез, поправил правила mod_rewrite, взяв их из работающего рядом B24 CRM
/rest/ заработал

site.domain/rest/app.info?auth=d
{"error":"ERROR_CORE","error_description":"No client credentials"}
site.domain/rest/app.info
{"error":"NO_AUTH_FOUND","error_description":"Wrong authorization data"}

на вопрос где брать "credentials" в доке от B24 ответа не было
Пошёл смотреть страницы дальше по тому же запросу
Нашёл Статью от intervolga.
90% статьи не понял в программирование не вникал, но понял что нужна страничка с компонентом bitrix:rest.hook
Нарисовал страничку local/reg353/index.php по аналогии с другими

<?
require($_SERVER['DOCUMENT_ROOT'].'/bitrix/header.php');
$APPLICATION->SetTitle("test");
?><div>bitrix:rest.hook<hr/>
<?
		$APPLICATION->IncludeComponent(
	"bitrix:rest.hook", 
	".default", 
	array(
	),
	false
);?>
	</div>

Какие-то картинки на ней появились, но при переходе на
site.domain/local/reg353/ap/0 упорно получал 404

Пошёл искать дальше
Нашёл https://dev.1c-bitrix.ru/support/forum/forum6/topi...
Там пишут, что техподдержка отвечает

Вы можете разместить компонент bitrix:rest.marketplace.localapp на странице и добавлять приложения в БУСе

ок

<?
require_once( $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/main/include/prolog_admin_before.php" );

require_once( $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/main/include/prolog_admin_after.php" );

$APPLICATION->IncludeComponent("bitrix:rest.marketplace.localapp", "", array(),
    false,
    array()
);

require( $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/main/include/epilog_admin.php" );

красивая страница, кнопки не тычутся
Идём дальше
https://dev.1c-bitrix.ru/community/webdev/user/663...
Там пишут - рабочий вариант
/local/rest/index.php

<?php require_once($_SERVER['DOCUMENT_ROOT'] . "/bitrix/modules/main/include/prolog_admin.php"); ?>
   <div class="adm-workarea">
       <? $APPLICATION->IncludeComponent(
           "bitrix:rest.hook",
           ".default",
           [
               "SEF_MODE" => "Y",
               "SEF_FOLDER" => "/local/rest/",
               "COMPONENT_TEMPLATE" => ".default",
               "SEF_URL_TEMPLATES" => [
                   "list" => "",
                   "event_list" => "event/",
                   "event_edit" => "event/#id#/",
                   "ap_list" => "ap/",
                   "ap_edit" => "ap/#id#/",
               ]
           ],
           false
       ); ?>
       <br>
       <a href="jav * ascript:void(0)" class="adm-btn adm-btn-green"
           oncl ick="BX.PopupMenu.show('rest_hook_menu', this, [{
              'href':'/local/rest/event/0/',
              'text':'Исходящий вебхук'
           },{
              'href':'/local/rest/ap/0/',
              'text':'Входящий вебхук'
           }])">
           Добавить вебхук
       </a>
   </div>
<? require($_SERVER["DOCUMENT_ROOT"] . "/bitrix/modules/main/include/epilog_admin.php");

в urlrewrite.php добавляем

array(
   'CONDITION' => '#^/local/rest/#',
   'RULE' => '',
   'ID' => 'bitrix:rest.hook',
   'PATH' => '/local/rest/index.php',
),

Рабочий вариант не работает, при попытке нажать на добавление входящего хука всё тот же 404
Что за нах ?
Включение LogLevel info rewrite:trace6 в апаче показывает что всё уходит в urlrewrite.php и там остаётся

Понятно, что с urlrewrite что-то не то
Что "не то" - не знаю, зато вижу в его настройках кнопочку "Пересоздание"
Жму её, она потирает настройку про '#^/local/rest/#', добавляю её обратно

Теперь переход по кнопочке работает и входящий хук удаётся добавить

По указанным кредам идём в другом окошке в очередной запрос
site.domain/rest/17607/p8n2dh2hf2nf258n/profile
- видим что хочет https

{"error":"INVALID_REQUEST","error_description":"Https required."}

ок, добавляю на сайт поддержку https (нам не надо было), повторяю
https://site.domain/rest/17607/p8n2dh2hf2nf258n/pr...

{"result":{"ID":"17607","ADMIN":true,"NAME"....

Profit!

Всё действо заняло менее часа, включая копание с rewrite, генерацию и настройку сертификатов

Что я сделал не так ?

...В виде полного ответа не оформил. сейчас....

Answer 2

[Mikhail Prokhorov]

Вот здесь посмотрите
https://dev.1c-bitrix.ru/learning/course/index.php...

Comments

[Дмитрий Дев]

Mikhail Prokhorov у меня нет файлов api.php и web.php. У меня БУС тариф бизнес.

[Mikhail Prokhorov]

Дмитрий Дев,
Их нужно создать в /local/routes/

[Дмитрий Дев]

Mikhail Prokhorov, Я что-то не понимаю зачем это. Какие скрипты в этих файлах должны быть?

Answer 3

[Евгений]

Мой вариант реализации для собственного модуля. История мутная, слишком много вопросов, слишком мало ответов, документации для этого модуля в БУС до сих пор нет, лишь вот эти несколько абзацев, на предмет как можно пробросить свои контроллеры в REST Битрикс, удобно иметь схожие методы и схемы данных для SPA и приложения. Добавил в описание контроллера нужное, в адресной строке перешел к нужному методу и словил так-же wrong_authorization. Ни где нет описания как создавать токены непосредственно в БУС. Единственная зацепка, статья интерволги, и пример от MaxKozlov, с одной лишь разницей, другой путь к странице, не в /local/.., потому что это служебная папка для разработки, и не нужно ни чего добавлять в urlrewrite.php, так как в настройках модуля уже есть SEF_MODE = Y и массив шаблонов ссылок SEF_URL_TEMPLATES, только нужно сохранить код страницы в визуальном редакторе Битрикс(это важно), и нужные записи в urlrewrite.php пропишутся автоматом. После чего получилось создать входящий токен, но моего модуля в правах не было, выбрал iblock, в таблице базы данных с правами доступа к rest ручками переправил на название своего модуля, и всё заработал.

Переходим по ссылке:

https://сайт/rest/1/токен/имя:модуля.api.имякласса.метод

..и наслаждаемся результатом.

имя:модуля.api - defaultNamespace, указанный в контроллере - докумантация.

PS: Для понимания, то-же самое у меня получает SPA через интерфейс ajax

https://сайт/bitrix/services/main/ajax.php?action=имя:модуля.имякласса.метод

но там другая структура выполнения и вэб авторизация.