API биржи перевозок

Для того, чтобы начать работать с пользователями, требуется открыть http соединение по адресу api.lbr.ru

Список разделов:

Добавление/редактирование перевозки/перевозчика Получение данных о перевозке/перевозчике Удаление перевозки/перевозчика Статистика - получение данных о всех архивных перевозках

Добавление/редактирование перевозки/перевозчика

URL : api.lbr.ru/tr?m=set

Параметры:

  • action - тип передаваемых данных. Принимаемые: transport, user.
  • data - массив с данными. Может быть многомерным массивом с несколькими перевозками/перевозчиками.

  • Принимаемые параметры data при action=transport:
    • Параметр Тип Описание
    • t_id (integer) Идентефикатор перевозки в системе учета. Уникальный. Обязательный
    • type (integer) Тип перевозки. 0 - международная, 1 - региональная
    • user_id (mixed) Идентефикатор пользователя в системе учета, создавшего перевозку
    • start_rate (integer) Стартовая сумма ставки
    • currency (integer) Валюта. 0 - рубли(руб), 1 - доллары($), 2 - евро(€)
    • location_from (string) Место загрузки
    • location_to (string) Место разгрузки
    • date_close (date) Дата и время закрытия заявки. Формат - YYYY-MM-DD H:i:s
    • date_from (date) Дата загрузки. Формат - YYYY-MM-DD
    • date_to (date) Дата разгрузки. Формат - YYYY-MM-DD
    • auto_info (string) Информация об автомобиле
    • description (string) Описание
    • new_transport (int) Произвести рассылку писем о появлении перевозки
    • pto (string) Экспорт ПТО
    • points (array) Массив с промежуточными точками:
      • Параметр Тип Описание
      • point (string) Название/место
      • date (date) Дата. Формат - YYYY-MM-DD

  • Принимаемые параметры data при action=user:
    • Параметр Тип Описание
    • inn (integer) ИНН/УНП. Уникальный. Обязательный
    • company (string) Название компании без кавычек
    • country (string) Страна
    • region (string) Область
    • city (string) Город
    • district (string) Район
    • email (mixed) E-mail адрес. Уникальный
    • name (string) Имя контактного лица
    • surname (string) Фамилия контактного лица
    • secondname (string) Отчество контактного лица
    • certified (integer) Сертифицирован. 0 - нет, 1 - да
    • unsubscribed (integer) Отказался от рассылки. 0 - нет, 1 - да
    • phone (integer) Номер телефона
    • phone2 (integer) Дополнительный номер телефона
    • type (integer) Тип. 0 - общий, 1 - региональный, 2 - международный
    • persons (array) Дополнительные контактные лица:
      • Параметр Тип Описание
      • email (mixed) E-mail адрес. Уникальный. Обязательный
      • name (string) Имя контактного лица
      • surname (string) Фамилия контактного лица
      • secondname (string) Отчество контактного лица
      • unsubscribed (integer) Отказался от рассылки. 0 - нет, 1 - да
      • phone (integer) Номер телефона
      • phone2 (integer) Дополнительный номер телефона
      • type (integer) Тип. 0 - общий, 1 - региональный, 2 - международный
Примеры:

Пример добавляет/редактирует две перевозки:

            action = 'transport'
            data[1][t_id] = '1N34'
            data[1][type] = '0'
            data[1][user_id] = '82324'
            data[1][location_from] = 'Ставрополь'
            data[1][points][1][point] = 'Уфа'
            data[1][points][1][date] = '2014-03-14'
            data[1][points][2][point] = 'Москва'
            data[1][points][2][date] = '2014-03-16'
            ...
            data[2][t_id] = '2U52'
            data[2][type] = '1'
            data[2][user_id] = '23424'
Пример добавляет/редактирует одну перезовку: 
            action = 'transport'
            data[t_id] = '1N34'
            data[type] = '0'
            data[user_id] = '82324'
Пример добавляет/редактирует два перевозчика: 
            action = 'user'
            data[1][inn] = '345678999888'
            data[1][company] = 'ООО ЛБР-Агромаркет'
            data[1][country] = 'РФ'
            ...
            data[2][inn] = '234948756732'
            data[2][company] = 'ИП Жорик и Борик'
            data[2][country] = 'РФ'
            data[2][persons][0][email] = 'email@mail.com'
            data[2][persons][0][name] = 'Имя_контактного_лица'
            data[2][persons][0][surname] = 'Фамилия_контактного_лица'
Пример добавляет/редактирует одного перевозчика: 
            action = 'user'
            data[inn] = '345678999888'
            data[company] = 'ООО ЛБР-Агромаркет'
            data[country] = 'Беларусь'

Получение данных о перевозке/перевозчике

URL: api.lbr.ru/tr?m=get

Параметры:

  • action - тип передаваемых данных. Принимаемые: transport, user.
  • data - массив с идентефикаторами перевозок/перевозчиков.

Статус перевозок может быть следующим:

  • 0 - перевозка закрыта
  • 1 - перевозка активна
  • 2 - перевозка переведена в черновики
  • 3 - перевозка удалена (причина удаления указана в поле deletereason)

Примеры:
Пример вернет xml-файл с информацией о двух перевозках 
            action = 'transport'
            data[1][t_id] = 'UPR-009041'
            data[2][t_id] = '2U52'

Возвращаемый xml: 
            <transport t_id="UPR-009041">
                <status>0</status>
                <deletereason></deletereason>
                <datepublished>2014-04-01 10:48:03</datepublished>
                <dateclose>2014-04-01 15:00:00</dateclose>
                <editstatus>Перевозка участвует в торгах. Изменение невозможно.</editstatus>
                <startprice>1800</startprice>
                <ratescount>9</ratescount>
                <memberscount>6</memberscount>
                <win>
                    <inn>300004425</inn>
                    <nds>0</nds>
                    <price>1600.0</price>
                    <currency>2</currency>
                    <date>2014-04-01 13:46:25</date>
                </win>
            </transport>
            <transport t_id="2U52">
                <status>1</status>
                <deletereason></deletereason>
                <datepublished>2014-04-01 10:48:03</datepublished>
                <dateclose>2014-04-15 15:00:00</dateclose>
                <editstatus></editstatus>
                <startprice>1200</startprice>
                <ratescount>0</ratescount>
                <memberscount>0</memberscount>
            </transport>

Удаление перевозки/перевозчика

URL: api.lbr.ru/tr?m=del

Параметры:

  • action - тип передаваемых данных. Принимаемые: transport, user.
  • data - массив с данными. Может быть множественным массивом с несколькими перевозками/перевозчиками.

  • Принимаемые параметры data при action=transport:
    • Параметр Тип Описание
    • t_id (integer) Идентефикатор перевозки в системе учета. Уникальный. Обязательный

  • Принимаемые параметры data при action=user:
    • Параметр Тип Описание
    • inn (integer) ИНН/УНП. Уникальный. Обязательный
Примеры:

Пример удаляет две перевозки 

            action = 'transport'
            data[1][t_id] = '1N34'
            data[2][t_id] = '2U52'
Пример удаляет одну перезовку: 
            action = 'transport'
            data[t_id] = '1N34'
Пример удаляет два перевозчика: 
            action = 'user'
            data[1][inn] = '345678999888'
            data[2][inn] = '234948756732'
Пример удаляет одного перевозчика: 
            action = 'user'
            data[inn] = '345678999888'

Статистика - получение данных о всех архивных перевозках

URL: api.lbr.ru/tr?m=get

Параметры:

  • action - тип передаваемых данных. Принимаемые: statistics.
Примеры:
Пример вернет xml-файл с информацией о всех архивных перевозках 
            action = 'statistics'

Возвращаемый xml: 
            <data count="2">
                <transport t_id="UPR-009041">
                    <status>0</status>
                    <datepublished>2014-04-01 10:48:03</datepublished>
                    <dateclose>2014-04-01 15:00:00</dateclose>
                    <startprice>1800</startprice>
                    <ratescount>9</ratescount>
                    <memberscount>6</memberscount>
                    <win>
                        <inn>300004425</inn>
                        <nds>0</nds>
                        <price>1600.0</price>
                        <currency>2</currency>
                        <date>2014-04-01 13:46:25</date>
                    </win>
                </transport>
                <transport t_id="2U52">
                    <status>0</status>
                    <datepublished>2014-04-01 10:48:03</datepublished>
                    <dateclose>2014-04-15 15:00:00</dateclose>
                    <startprice>1200</startprice>
                    <ratescount>0</ratescount>
                    <memberscount>0</memberscount>
                    <win>
                        <inn></inn>
                        <nds></nds>
                        <price></price>
                        <currency>2</currency>
                        <date></date>
                    </win>
                </transport>
            </data>