﻿# API в приложениях

> [HTML Version](360009921431.html)

**ELMA365 API** — это инструмент для интеграции ELMA365 со сторонними системами. Веб-запросы с использованием методов API позволяют получать элементы приложения, выполнять действия с ними, импортировать данные из файла и т. д. Полный список доступных методов можно найти в [справке по публичному API ELMA365](https://api.elma365.com/ru/public-api/reference/app/).

Чтобы увидеть основные методы для работы с приложением, рядом с его названием нажмите значок шестерёнки и выберите пункт **API**.

**(360009921431-1.png)**

На открывшейся странице вы можете посмотреть подробную информацию о методах и [проверить свой запрос](#test-request).

## Список методов API

Для каждого метода отображается отдельный блок, который можно раскрыть для просмотра полной информации. Блок включает:

**(360009921431-2.png)**

1. Заголовок:

- используемый метод HTTP-запроса — `GET`, `POST` и т. д.;

- относительный адрес метода API;

- название действия;

- кнопки для работы с методом:

	- **(copy-icon.png) **— чтобы скопировать его полный адрес для использования в запросах;

	- **(question-mark-icon.png) **— для перехода к подробному описанию метода в справке по публичному API ELMA365.

2. Раздел **Параметры** — здесь можно посмотреть формат передаваемых значений и структуру запроса. Если для метода приведён пример запроса, вы можете скопировать его, нажав в правом верхнем углу поля значок **(copy-icon.png).**

3. Раздел **Ответы** — коды и описания возможных ответов от сервера.

## Проверка запроса

На странице можно составить запрос и проверить его работу.

Обратите внимание, пробные запросы выполняются в системе. Например, при проверке методов API для создания или редактирования элементов приложения произойдёт изменение данных.

Чтобы проверить запрос:

1. Раскройте блок с информацией о методе и в правом верхнем углу нажмите **Попробовать**.

2. В разделе **Параметры** в зависимости от метода:

	- задайте передаваемые значения — например, идентификатор элемента приложения;

	- напишите тело запроса по шаблону.

Чтобы вернуться к первоначальному значению, нажмите в поле ввода значок **(discard-icon.png)**. Вы также можете скопировать тело запроса, нажав **(copy-icon.png)**.

3. Под списком параметров нажмите кнопку **Выполнить**.

В разделе **Ответы** отобразятся:

- **Адрес запроса** — URL запроса, сформированный с учётом параметров. Для копирования нажмите справа значок **(chain_icon.png);**

- **Ответ от сервера** — код и тело полученного ответа. Чтобы скопировать тело ответа, нажмите значок **(copy-icon.png).**

 **(360009921431-3.png)**

Чтобы данные пробного запроса не занимали место на странице, удалите их, нажав внизу раздела **Параметры** кнопку **Очистить**. 

Чтобы отключить режим проверки, в правом верхнем углу блока нажмите **Отмена**.