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

API — программный интерфейс для взаимодействия сторонних приложений с нашей программой.

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

Каждый запрос должен содержать обязательные параметры и параметры запрашиваемого метода. В общем виде запрос выглядит так: https://1c.j2-service.ru/{CLIENT_ID}/j2/hs/api?service={SERVICE_ID}&action={METHOD_ID}&parameter1=...&parameter2=...

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

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

Last updated