Порядок работы с API
====================

.. _Configuring-REST:

Включение интеграции по REST
----------------------------

Для включения интеграции по REST со стороны SAP нужно произвести ведение
настроек в таблице ``/TRL/XDE_CUST``. Для этого, с помощью транзакции SM30,
нужно перейти к ведению таблицы ``/TRL/XDE_CUST``. Следующие настройки
должны быть выполнены в этой таблице:

-  ``IM.INTEGRATION_TYPE`` = «WS» (Тип интеграции между модулем 
   xDE для SAP и ИМ (WS/RFC)
-  ``IM.WS_INTEGRATION`` = «REST» (Тип интеграции по Web сервису REST)
-  ``IM.WS_JSON_ENCODING`` = «utf-8» (Используемый тип кодировки при конвертации тела JSON)

Другие настройки связанные с работой сервисов REST хранятся в таблице ``/TRL/XDE_REST_SV``.
Подробнее о них можно прочитать в разделе :ref:`sap_rest_manual_settings`. 

Настройка методов для работы по REST
------------------------------------

Для настройки методов для работы по REST существует таблица
``/TRL/XDE_REST_ST`` и транзакция для ведения данной таблицы ``/TRL/XDE_REST``.

Таблица ``/TRL/XDE_REST_ST`` имеет следующие поля:

.. list-table:: Список полей таблицы /TRL/XDE_REST_ST
   :widths: auto
   :header-rows: 1

   * - Поле
     - Ключ
     - Тип данных
     - Длина
     - Дес.Разряды
     - Описание
   * - MANDT
     - X
     - CHAR
     - 3
     - 0
     - Мандант
   * - OPER_NAME
     - X
     - CHAR
     - 100
     - 0
     - Имя операции
   * - HTTP_TYPE
     - 
     - CHAR
     - 10
     - 0
     - Тип HTTP запроса
   * - METH_NAME
     - 
     - CHAR
     - 61
     - 0
     - Имя метода
   * - CREATE_BODY
     - 
     - CHAR
     - 30
     - 0
     - Имя ФМ для создания тела http-запроса
   * - INPUT_FM
     - 
     - CHAR
     - 30
     - 0
     - Имя ФМ для обработки тела ответа http-запроса

Поле «Имя операции» содержит кодовое название операции, являющееся
ключом для выполнения метода или отдельного шага метода интеграции с ИМ.

Поле «Тип HTTP запроса» указывает на то, какой функциональный модуль SAP
запускать: HTTP_POST/HTTP_GET.

Поле «Имя метода» содержит в себе часть пути для обращения к методам
REST API. В некоторых методах содержится изменяемая часть, например,
``{DOCUMENT_ID}``, это значит, что вместо этого тега будет подставлено
конкретное значение.

Поле «Имя ФМ созд тела запроса» содержит в себе имя ФМ, который, при его
наличии и существовании в системе, будет вызван для создания тела
запроса, который необходим для POST запросов.

Поле «Имя ФМ для обработки вход. данных» содержит в себе имя ФМ,
который, при его наличии и существовании в системе, будет вызван для
того, чтобы обработать данных, полученные от метода REST API.