5. Вызов ресурсов.
Запросы к API TEXENERGO передаются по протоколу HTTPS.
Формат запроса:
<ТипМетода>https://www.texenergo.ru/<АдресAPI>/<ВерсияAPI>/<ОбъектРесурса>/<МетодРесурса>/?<параметры>
где:
- <ТипМетода> – в API TEXENERGO для запросов используются методы GET и POST.
- <АдресAPI> – URL API TEXENERGO (/api-clients/)
- <ВерсияAPI> – версия API, текущая версия «v1».
- <ОбъектРесурса> – объект над которым выполняется действие. Список объектов и их описание приведены в разделе «Список ресурсов для получения данных».
- <МетодРесурса> – метод, который требуется применить к объекту. Список методов и их описание приведены в разделе «Список ресурсов для получения данных».
- <Параметры> – обязательные и необязательные параметры запроса, которые не входят в состав URL ресурса.
API TEXENERGO возвращает ответы в кодировке UTF-8, формат ответа: JSON.
В случае возникновения ошибки обработка запроса прекращается и возвращается сообщение. Список ошибок и их описание приведены в разделе «Список ресурсов для получения данных».
При любом запросе возвращаются данные:
- status – статус ответа
- 200 – запрос обработан
- 403 – ошибка доступа (не верный логин:ключ)
- result – содержимое ответа
- request_date – дата запроса
- request_method – метод запроса (GET, POST)
- ip_address – IP адрес запроса
- object – объект запроса (order, pricelist, …)
- action – действие над объектом (н-р, getPriceNoBrandXLS)
- parameters – переданные параметры в запросе
- api_version – версия API TEXENERGO
- AUTHORIZATION_TOKEN – пара логин:ключ для авторизации
- RESULT_DATA – данные ответа на запрос