Программный интерфейс (API) Forum-Auto предназначен для автоматизированного обмена заказами и веб-проценки ассортимента.
После подключения к сервису вы получаете логин и пароль, которые необходимо передавать в каждом запросе.
Данные передаются в кодировке UTF-8.
Сервис доступен только по протоколу HTTPS.
Первая версия API Forum-Auto работает по протоколу обмена SOAP/XML. Входные и выходные структуры данных передаются в теле запроса и ответа.
Адрес сервиса: https://api.forum-auto.ru/soap
Для сервиса существует описание на языке WSDL (Web Services Description Language), в котором представлены методы, входные и выходные структуры данных, типы данных и другое.
Адрес WSDL: https://api.forum-auto.ru/wsdl
Пример работы с сервисом на PHP.
Вторая версия веб-сервиса построена на REST-принципах.
Запрос от клиента к серверу выполняется методом GET
https://api.forum-auto.ru/v2/имя_метода?параметры,
тело ответа всегда в формате JSON.
Пример вызова метода clientInfo:
https://api.forum-auto.ru/v2/clientinfo?login=ЛОГИН&pass=ПАРОЛЬ
При вызове методов возможно возникновение ошибок и предупреждений.
Они возвращаются в форме ошибки SOAP (элемент XML Fault).
| Переменная | Тип | Описание |
|---|---|---|
| FaultCode | integer | Числовой код ошибки или предупреждения. |
| FaultString | string | Текст сообщения об ошибке или предупреждения. |
| Detail | string | Подробное описание ошибки или предупреждения. |
Описание всех ошибок можно посмотреть в разделе Коды ошибок