> 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]: Параметры метода.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.j2-service.ru/obshaya-informaciya.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.