Формат запроса

Remote API  >

Формат запроса

Previous pageReturn to chapter overviewNext page

Все запросы осуществляются только методом POST. Дополнительные параметры («par») должны быть представлены в формате JSON. Ответ так же возвращается в виде JSON. Все текстовые параметры предполагают использование кодировки UTF-8.

Есть два вида обращений:

1. В случае если длина параметра «par» меньше 1000 символов, можно использовать вызов “/api?”, вставляя «par» прямо в URL.

 

 “http://{host}/LiwAPI/Service.svc/api?api_key=<text>&com=<text>&par={<text>}"

 

Текущий host HTTP http://ae2.antor.ru:8090

Текущий host HTTPS https://ae2.antor.ru:8091

Проверка доступа http://ae2.antor.ru:8090/LiwAPI/Service.svc/hello

 

2. Если длина «par» больше 1000 символов, следует использовать вызов “/api_stream?”, добавляя «par» в поток запроса.

                 

                      “http://{host}/LiwAPI/Service.svc/api_stream?api_key=<text>&com=<text>”

 

В заголовке запроса обязательно указывать Content-Type:application/x-www-form-urlencoded

Параметры:

 

Название

Описание

api_key

уникальный ключ доступа к API

com

название команды

par

параметры команды

 

Пример:

 

http://localhost/LiwAPI/Service.svc/api?api_key=12345678-1234-5678-1234-123456787654&com=select/office&par={"office_id": 0 }