> For the complete documentation index, see [llms.txt](https://doc.j2-service.ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.j2-service.ru/obshaya-informaciya.md).

# Общая информация

### API — программный интерфейс для взаимодействия сторонних приложений с [нашей программой](/terminy.md#nasha-programma).

#### Работа с API состоит из отправки запроса и получения ответа посредством методов GET и POST протокола HTTP 1.1.

Каждый запрос должен содержать [обязательные параметры](broken://pages/QhlCufNUf64ItDpMOkRp) и параметры запрашиваемого метода. \
В общем виде запрос выглядит так:\
<https://1c.j2-service.ru/{CLIENT\\_ID}[^1]/j2/hs/api?service={SERVICE\\_ID[^2]}\\&action={METHOD\\_ID[^3]}\\&parameter1=...\\&parameter2=...[^4>]<br>

Идентификатор сервиса, идентификатор метода и его параметры могут быть переданы как в адресной строке, так в и заголовках HTTP-методов GET и POST. \
Идентификаторы и имена параметров регистронезависимы. \
При наличии одинаковых параметров в адресной строке и в заголовке приоритетным является значение параметра в заголовке даже если оно пустое.

Параметры могут быть упакованы в строку BASE64. В этом случае в адресной строке или заголовке http-метода должен быть передан параметр **data**, значением которого является строка BASE64 с параметрами метода. \
Пример:\
<https://1c.j2-service.ru/test/j2/hs/api?data=eyJzZXJ2aWNlIjoiSk0iLCJhY3Rpb24iOiJ...(skip)>

[^1]: Идентификатор вашей компании в нашем сервисе.\
    Регистрозависим и должен передаваться строчными буквами.

[^2]: Идентификатор сервиса. Регистронезависим.

[^3]: Идентификатор метода.\
    Регистронезависим.

[^4]: Параметры метода.